「ドキュメント作成時」と題しているが、
どんなものを作るときも注意したいこと
- 何をゴール（何がわかる・何ができる）とするものなのか念頭に置いた上でそこに向けて作成すること
- 何のためにこう書いているのかわからない、という点が無いこと
-
記述ルールが統一されていること
- 半角と全角。特に数字や括弧、空白など
- ブランクの記述ルール。空欄にするのか、「-」や「なし」と書くのか
- フォントサイズ
- 強調の仕方（フォントカラーや太字、マーキング）
- どの欄にどんな粒度の情報を書くのか
- ユーザ（読者）の理解度・知識を想定し、それに応じたレベルで記述すること
-
不要なものがないこと
- 無意味な罫線
- 古い情報・曖昧な情報は極力さくじょする。残すなら、TODOコメントなどによってを明示しておく
フォントサイズ、マーキングのカラー、セル幅ひとつとっても
意味があります。
意図を持ってものをつくるのが大切です。
綺麗に作るために整えるのではなく、理解しやすくするために整えるのです。
自分のレベルと要求と納期のバランスも大事です。
上記に書いてあるようなことに気を配らなくていい場合もあります。そのときは、何故しなくてよいのかを自分自身が理解できているようにします。
すぐすぐベストのものを作るのは難しいですが、
まずは気を付けてものを作る、それを繰り返したり少し時間が経ってから見直してまた直す……
ということをやっていく内にスキルは身についてくると思います。
（私もまだまだ）