기타
Technical Writing: 글로 하는 의사소통 / if(kakao)2022
두줄요약
독자에게 필요한 정보를 쉽게 전달하기 위한 테크니컬 라이팅 원칙을 정리했습니다.\n주제·독자·목차 설계부터 문장 작성과 최종 검토 방법까지 안내합니다.
구조와 흐름
- 글쓰기 전·중·후 단계로 구분한 테크니컬 라이팅 실천 흐름
- 주제와 독자 설정, 목차 구성 후 본문 작성과 최종 검토로 이어지는 구성
- 정보 전달력 향상을 위한 문서 아키텍처 설계 강조
핵심 내용
- 작성자 중심이 아닌 독자에게 필요한 정보를 쉽게 전달하는 목표
- 독자 여러 명의 이해 비용을 줄이기 위한 작성자 시간 투자
- 두괄식, 일관된 용어, 간결·능동·긍정·명확한 문장, 목록과 시각 요소 활용
주의할 점
- 대명사·생략·불필요한 약어로 인한 문맥 추적 비용
- 오타 수정에만 치우치지 않은 문단 흐름과 설명 충분성 점검
- 변경 사항 반영 없는 문서의 노후화와 모든 내용을 한 문서에 담는 방식
적용해볼 점
- 검토 단계에서 목차 부합성, 용어 일관성, 불필요한 문장, 용어 해설 확인
- 구두 낭독을 통한 어색한 문장과 긴 호흡 발견
- 갱신 가능한 문서 분리와 링크 대체 텍스트 제공
