직장에 다니기 시작하면서 남들이 볼 수 있는 문서 작성을 하기 시작했다. 평소에 노트를 항상 가지고 다니고 일기를 매일 쓰고 있으니 문서 작성도 쉬울거라 착각했다. 하지만 모니터 앞에 앉아 키보드를 잡으면 머릿속이 새하얘졌다. 참고를 위해 다른 사람들의 문서를 읽고 다시 문서 작성을 했더니 글은 쓸 수 있었다. 문서 작성을 마치고 나니 과연 이 문서를 처음 보는 사람도 내가 말하고자 하는 바를 명확하게 이해할 수 있을까 걱정이 들었다. 문장이 매끄럽지 못하다는 생각도 들었고 모호한 표현도 많았다. 하지만 고치려고 해봐도 어떻게 손을 대야할지 감이 오지 않았다. 특히 기술문서는 명확해야한다. 일을 하다 여러 기술문서를 읽다보면 그래서 무슨 말이야 이게 하는 상황이 종종 있다. 이 글은 언어학의 관점에서 문서 작성 시에 가독성을 높히기 위해 어떻게 해야하는지 알려준다. 문장의 어색함과 모호함이 어디에서 오는지 예시와 함께 알려주어 내가 작성한 문서가 왜 이상한지를 쉽게 깨달을 수 있었다.

언어학 관점에서의 기술문서 가독성 향상 전략 #기술문서 #테크니컬라이터 #TW

카카오엔터프라이즈 기술블로그 Tech&(테크앤)

언어학 관점에서의 기술문서 가독성 향상 전략 #기술문서 #테크니컬라이터 #TW

다음 내용이 궁금하다면?

또는

이미 회원이신가요?

2021년 3월 4일 오전 12:57

댓글 1

  • 삭제된 사용자

    2022년 04월 14일

    글쓰기 도전