문서화 작업을 할 때 가장 중요하게 생각하는 점을 설명
문서화 작업에서 가장 중요하게 생각하는 것은 읽는 사람을 먼저 떠올리는 것입니다. 누가 언제 어떤 상황에서 이 문서를 볼지를 생각하면, 어느 수준까지 설명해야 하는지와 무엇을 생략해도 되는지가 명확해졌습니다. 작성자 시점이 아니라 독자 시점으로 쓰는 것이 가장 어렵지만 중요한 원칙이었습니다.
목적, 배경, 결론, 근거의 순서로 구조화하면 읽는 흐름이 자연스러워졌습니다. 나중에 이 문서를 내가 다시 봤을 때 이해가 되는가를 기준으로 검토하는 것이 효과적이었습니다. 작성 당시에는 당연하게 느껴지는 맥락이 시간이 지나면 사라지기 때문입니다. 문서는 완성이 없고, 사용하면서 개선되는 것이 더 중요했습니다. 처음부터 완벽하게 쓰려는 부담보다, 빠르게 초안을 만들고 피드백으로 보완하는 방식이 더 효율적이었습니다.