커뮤니케이션은 어느 직종이든 중요한 역량 중 하나다. 개발자 입장에서 소통의 대상은 크게 개발 직군이거나 비개발 직군이거나 둘 중 하나다.
이러한 소통 중 하나는 작업 결과물을 설명하는 문서로 이뤄지게 되는데, 흔히 API 문서가 하나의 예시이다.
기술 문서는 글쓰기와 몇 가지 다른 점이 있다.
명확한 대상 독자
어느정도 맥락을 이해하고 있는 개발자가 개발에 활용하기 위한 목적을 가지고 글을 읽는다.
글의 목적
정보 전달이 목적이라 작가의 개성이나, 감정 표현을 제외하고 명확하게 일관된 내용이 필요하다.
글의 구조
기-승-전-결과 같은 스토리텔링 구조보다는, 논리/계층적인 구조를 가지며 그림 및 예시 코드 등이 포함된다.
정보의 갱신
기술 문서는 시간이 지나면서 기능이 추가되거나 변경/삭제될 수 있기에 이를 반영한 유지보수가 필요하다.