ドキュメントの書き方

ドキュメントを書く際の心得(我流ですが大体これで書けます)書いときます。

・「目的」：作成するドキュメントは何のために作成するのか。どんなことを伝えたいのか
・「対象」：誰に向けてドキュメントを書くか(ドキュメントを見る人の素性(性格、知識など))

※「全体で意識すること」の内容から決まります。

・「流れ(ストーリー)」：繋がりがないドキュメントはどう読んでいいかわからない
　　　　　　　　　　　　前から後ろへが絶対。後ろから前はNG。
・「粒度」：ドキュメントに書く情報量　(取り扱い説明書に詳細設計はいらない)
　　　　　　段落での内容(「大きな項目」から「小さな項目」が基本)

私も書いてるうちに「目的」を見失うことがありますが、
書いてる時に、時々俯瞰でみることを意識するといいかと思います。