문서의 범위를 명시하라
좋은 문서는 문서 범위를 명시하는 것으로 시작한다 (scope statement). 문서에는 없지만 독자들이 기대할지도 모르는 범위에 대해 명시하면 더 좋다 (non-scope statement).
Scope statement와 non-scope statement는 독자뿐만 아니라 저자에게도 도움이 된다. 글을 쓰는 동안 문서의 내용이 주제에서 벗어나지 않게 도와준다.
독자를 명시하라
문서의 독자가 누구인지 명시하라. 추가적으로 문서를 이해하기 위해 어떤 사전 지식이나 경험이 필요한지 적으면 좋다. 필요하다면 사전에 읽어야 하는 문서를 따로 명시하라.
중요한 포인트를 문서 앞에 놓아라
독자들은 바쁘다. 가장 필수적인 내용을 문서 앞에 놓아라.
첫 페이지에 공을 많이 들여라. 필요하다면 여러번 수정하라.
긴 문서의 경우 요악을 적어라. 지루하고 이해하기 어렵다면 독자들은 떠날 것이다.
독자를 위해 문서를 써라
독자를 정의하라
- 타켓 독자는 누구인가?
- 문서를 읽기전에 독자들이 이미 알고 있는 것은 무엇인가?
- 문서를 읽고나서 독자가 알아야 할 혹은 할 수 있어야 할 것은 무엇인가?
독자에게 맞게 문서의 윤곽을 그려라
독자를 정의한 후 독자의 필요에 맞게 문서의 윤곽을 그려라.
주제를 섹션으로 나누어라
코드를 모듈화하는 것 처럼 문서를 모듈화하면 읽고 이해하기 쉽고 유지보수하기에도 좋다.
빈 병에 자갈, 모래, 물을 넣는다고 한다면 자갈 -> 모래 -> 물 순으로 넣는 것이 가장 좋을 것이다.
독자의 머리는 빈 병과 같다. 문서의 내용은 자갈, 모래, 물의 세 크기로 나눌 수 있다. 자갈은 탑 헤더, 모래는 그 아래 헤더, 그리고 물은 문단과 리스트로 볼 수 있다.
글을 쓰기 전 몇 분 정도의 시간동안 문서의 내용을 대략적으로 설명해보아라. 아마 그것이 문서의 큰 구조일 것이다.