어렵고 복잡한 기술 내용, 잘 쓰려면🙄 학교 | 커리어리

어렵고 복잡한 기술 내용, 잘 쓰려면🙄 학교에서도 회사를 다니면서도 IT기술을 풀어쓰기란 참 어려웠습니다. 거기다 잘 읽히고, 이해가 잘 가도록 쓰는건 더더욱 어려웠죠😥 저같은 고민을 하는 분들께 테크니컬 라이팅 원칙을 공유합니다. 1. 명확성 - 내용의 모호함이나 혼란없이 독자가 한 번에 이해하도록 쓰기 - 내가 알더라도 남은 모를 수 있으니 상세하고 명확하게 쓰기 2. 간결성 - 기술적인 내용을 신속하고 정확하게 이해하도록 쉬운 단어와 간결한 문장 사용 - '~은 ~입니다' 형태로 가독성 높게 단문으로 작성 + 자세한 설명은 핵심 문장 밑에 개조식 느낌으로 3. 정확성 - 기술적 오류없이 독자가 필요한 정보를 정확하게 제공해서 신뢰도 높이기 - 변경된 내용은 바로바로 업데이트 4. 일관성 - 문서에 용어, 표현, 어조 등을 일관성 있게 사용하기 이 포스트에서는 조셉 풀리처의 명언을 인용했는데요, 와닿습니다. 짧게 써라, 그러면 읽힐 것이다. 명료하게 써라, 그러면 이해될 것이다. 그림같이 써라, 그러면 기억 속에 머물 것이다. 무엇보다 정확하게 써라, 그러면 그들은 그것의 빛에 의해 인도될 것이다.

테크니컬 라이팅 4대 원칙

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

2021년 11월 22일 오전 1:08

댓글 0

주간 인기 TOP 10

지난주 커리어리에서 인기 있던 게시물이에요!

현직자들의 '진짜 인사이트'가 담긴 업계 주요 소식을 받아보세요.

커리어리 | 일잘러들의 커리어 SNS