솔직한 경험 기반 접근
기술 문서를 작성할 때 가장 어려웠던 자리는 독자 수준을 맞추는 것이었습니다. 같은 내용을 기술 배경이 다른 팀원에게 전달하려면, 어디까지 설명하고 어디서 생략할지를 계속 고민했습니다. 수업 프로젝트 보고서를 쓸 때 모델 구조를 수식으로 설명했더니 비전공 팀원이 이해를 못 했습니다. 그 경험 이후로 개요·배경·세부 기술 순서로 문서를 구성하고, 수식은 별도 부록에 두는 방식으로 바꿨습니다. 또 코드 주석이 문서를 대체하면 안 된다는 것도 그때 배웠습니다. 주석은 무엇을 하는지를 말하지만, 문서는 왜 그렇게 했는지와 어떤 한계가 있는지를 담아야 한다고 생각합니다. 독자가 빠르게 맥락을 잡을 수 있도록 글을 쓰는 감각은, 실제로 써보면서 조금씩 잡히는 것 같습니다.