本気でドキュメントを書くときに気をつけている10のこと - Masa / Lino Blogテクニカルドキュメントを本気で書くときに気をつけていることをまとめてみます。 一応、私は雑誌等に執筆活動もやっています。 書き始める前 1. 目次を洗い出す ここでドキュメントの8割が決まるといっても過言ではないです。 この段階で抜け漏れ、重複を洗い出します。 特に複数人で執筆するときは特に重要です。 2. 書く内容をすべて実践する。 言うまでもないですが、テクニカルドキュメントは手を動かしてみないと書けません。 動かさないで書いてしまうと、嘘だらけのドキュメントが完成するでしょう。 テクニカルドキュメントではない場合は、全体をイメージします。 書いている途中 3. 文章は短く、シンプルに 同じことを伝えられるなら文章は短いほうが理解しやすいです。 ただ、舌足らずになるほど短くはしません。 根底にあるのはKISS(Keep It Simple, Stupid)です。 余談ですが、KISSは
