9beach

기술 문서를 쓸 때 주의해야 할 몇 가지

독자 배려

자신의 생각과 할 일을 정리하는 것이 기술 문서의 목표가 될 수는 없다. 먼저 독자를 식별하라. 그리고 독자를 배려하고 독자 입장을 생각하며 문서를 작성하라.

텍스트 파일의 장점

중요한 정보를 위키나 깃(Git)에서 텍스트로 작성하지 않고, 워드나 파워포인트 같은 이진 문서로 작성할 때마다 당신의 동료는 접근성, 가시성, 버전 관리 등 다양한 문제로 고생할 것이다.