본문 바로가기
728x90

테크니컬 라이팅

 (310)
논문 살펴보기 - 전자 제품 사용 설명서 텍스트 분석 (남경완) kakaoenterprise 기술 블로그에 올라온 글 중에서 "언어학 관점에서의 기술문서 가독성 향상 전략"이라는 글이 있었는데요. 여기 참고 문헌으로 있던 논문 중 하나입니다. 네이버 학술정보에서는 무료로 원문을 볼 수 있는 것처럼 나와있지만 실제 한국 학술지 인용색인(KCI) 사이트에서는 일부 미리보기만 지원합니다(회원 등급에 따라 다를 수 있겠지만 일반 회원인 경우에는 그렇습니다. KCI에서는 원문이 무료로 공개된 문서와 그렇지 않은 것이 구분되어 있습니다). https://tech.kakaoenterprise.com/100 원문을 무료로 보려면 "한국어문학국제학술포럼" 사이트에서 파일을 받을 수 있습니다. 사이트 메뉴에서 [e-Journal > 학술지 > 2018 > 제42권]에서 확인할 수 있습..
맞춤과 정렬 "정렬"은 "가지런하게 줄지어 늘어섬. 또는 그렇게 늘어서게 함"의 의미를 가지고 있습니다. 추가로 정보통신용어사전에서는 "문서를 작성할 때 문자열을 오른쪽, 중앙, 왼쪽 가운데 어느 한쪽을 기준으로 하여 맞추는 것. 예를 들어 문자열의 기준을 왼쪽으로 하면 모든 행에 나타나는 정보의 시작점이 같은 열에 나란히 있게 된다. 대부분의 문서 처리기 프로그램에서는 정렬 메뉴를 제공하고 있다"라는 풀이를 더하고 있습니다. 하지만 "맞춤"은 사전적 의미에서 글자의 배치 기준을 설정하는 풀이는 없습니다. 문서 도구를 보면 일부는 "정렬"을 일부는 "맞춤"을 사용합니다. 어떤 도구들이 어떤 용어를 사용하는지 살펴봅시다. 맞춤 구글문서 한국어는 모두 "맞춤"이라는 표현을 사용합니다. 하지만 영어로 표시를 변경해보면 a..
개조식 문장은 써도 되는건가요? 글쓰기 관련 서적이나 글을 보면 "개조식 문장"은 풀어쓴 글보다 직관적이고 이해하기 쉽다고 설명하고 있습니다. 하지만 이걸 잘못 이해해서 기계적으로 반영하다 보면 잘못된 문장을 작성할 수도 있습니다. * 개발자의 글쓰기 (김철수) ...여러 가지 요약 방법 중에서 서술식 문장을 개조식 문장으로 바꾸는 방법을 쓰면 내용이 자연스럽게 축약되고 의미는 더 분명해진다. 개조식 문장으로 만들려면 다음과 같이 불필요한 부사나 형용사, 조사나 어미를 없애고, 정확하고 적절한 단어로 대체하면 된다... * 개발자들을 위한 테크니컬 라이팅 10계명 https://tech.kakaoenterprise.com/110 ...테이블이나 간단한 안내 항목 등에서 '~다'의 종결 어미 대신 명사나 용언의 명사형(예: ~임, ~함)..
2022년 1월 테크니컬 라이팅 이런 저런 소식 1월 3일 카카오 엔터프라이즈 테크니컬 라이터 팀에서는 꾸준히 테크니컬 라이팅에 도움이 될 수 있는 글을 공유하고 있습니다. 이번에는 트러블슈팅에 관련된 내용입니다. 국내에서는 "문제 해결"로 번역해 사용하고 있습니다. 카카오 같은 경우도 "카카오 로그인 개발자 문서"에서는 "문제 해결"로 메뉴명을 표시하고 있습니다(하지만 위키피디아에서는 "트러블슈팅"과 "문제 해결" 문서가 따로 있습니다. "트러블슈팅"을 "문제 해결"의 일종으로 구분하고 있네요). https://developers.kakao.com/docs/latest/ko/kakaologin/trouble-shooting "...일반적으로 Troubleshooting 가이드는 오류 상황을 나타내는 오류 코드 혹은 오류 메시지, 문제 원인 및 증상,..
2021년 11월 테크니컬 라이팅 이런 저런 소식 11월 3일 올해 카카오 컨퍼런스 세션 중 글쓰기에 관한 세션이 있는지 찾아보았습니다. 테크니컬 라이터를 위한 글쓰기는 아니지만 오히려 더 어려운 사용자를 위한 글쓰기 가이드를 만들어낸 경험을 공유하는 세션이더군요(11월 16일 오전에 열리는 세션입니다). https://if.kakao.com/session/66 찾아보니 지난 8월에 카카오 메이커스 브런치를 통해 가이드에 대한 이야기를 공유하고 있었네요. 아마 브런치에 있는 내용이 세션에 담기지 않을까 싶습니다. 브런치 본문에 가이드 문서 PDF 파일을 내려받을 수 있는 링크가 있습니다. https://brunch.co.kr/@makerswithkakao/28 11월 5일 냉장고 소리 이해하기라는 독특한 콘텐츠입니다. 실제 냉장고 소리를 들어볼 수 있고..
2021년 12월 테크니컬 라이팅 이런 저런 소식 12월 10일 GitLab에서 공개한 테크니컬 라이팅 교육 자료입니다. 커뮤니티 기여자를 위한 간단한 교육 자료와 영상입니다(변경 이력을 보면 올해 5월 즈음에 오픈한 듯합니다). 사내 엔지니어를 위한 테크니컬 라이팅 교육 자료를 만들거나 제공할 때 참조하시면 좋을 듯합니다. https://about.gitlab.com/handbook/engineering/ux/technical-writing/fundamentals/ 자료를 보다가 GitLab 테크니컬 라이터, 매니저 Role에 대한 링크를 발견했습니다. 예전에 이런 자료 찾다가 못 찾았는데 잘 정리가 되어 있네요. 채용 프로세스도 설명이 되어 있는데 고객지원부서에서도 인터뷰에 참여한다는 것이 인상적이네요. https://about.gitlab.com/..
전원이 인가되다 가전제품 매뉴얼을 읽다 보면 바로 이해가 안 되는 문장들이 있습니다. 아래 문장도 그러한 문장입니다. "전원이 인가된 대기중인 상태"라는 것을 잘못 이해해서 전원을 켜고 일시 정지를 누르라는 것으로 이해했는데 찾아보니 그냥 전원이 연결된 상태라고 합니다. "인가"라는 단어를 사전에서 찾으면 그 의미가 나오지 않는데 "인가전압"이라는 단어는 등록되어 있네요. 국립국어연구소에서 발행하는 "새국어 소식"에서도 이런 문제를 지적하고 있습니다. https://www.korean.go.kr/nkview/nknews/200211/52_6.html 제품 설명문의 오류 / 김문오 (1) (증상): 버튼을 눌러도 동작이 되지 않는다. (확인 사항): 전원은 인가 되고 있습니까?, (조치 사항): 전원코드를 연결하여 주십 ..
WTD 프라하 2021 - 라이트닝 토크 모음 Abi Sutherland - The best tech writing you’ve never seen https://youtu.be/Xasef7oR25Y Abi Sutherland는 TomTom에서 Information Architect로 일하고 있습니다. 어디선가 들어본 회사다 싶었는데 API The Docs 2020에서 제품 마케팅 매니저가 발표한 적이 있었네요. 2021.06.25 - [테크니컬 라이팅] - API The Docs 2020 - 개발자 포털 사이트 개발 시 페르소나 활용하기 오래된 초보자를 위한 가이드북인 "How to Keep Your Volkswagen Alive: A Manual of Step-by-Step Procedures for the Compleat Idiot"을 소재로 ..
반응형

티스토리툴바