독자가 모른다고 가정하고 쓰는 방식을 중심으로 서술
문서를 쓸 때 독자가 아무것도 모른다고 가정하고 시작하는 것이 제 기본 방식입니다.
캡스톤 프로젝트에서 팀 내 환경 설정 가이드를 작성했을 때, 저는 당연히 알 것이라고 생각하고 파이썬 설치 단계를 생략했습니다. 그런데 팀원 한 명이 파이썬 자체를 처음 사용하는 상황이어서 첫 단계부터 막혔습니다. 그 경험 이후로 대상 독자가 어느 수준인지를 먼저 확인하고, 그보다 한 단계 더 아래에서 시작하는 방식을 택하게 됐습니다.
이후 같은 문서를 모든 단계를 포함해서 다시 쓰니, 팀원이 혼자 설정을 완료했습니다. 문서는 완성하고 나서 직접 따라해 보는 사람에게 검토를 부탁하는 것이 가장 효과적인 피드백 방식이라는 것도 배웠습니다.