どうも、突然の暑さに夏バテ気味なオムそばです。
GBW六日目は、軽めのお話。
皆さん、"備考欄"について、どのような記述をしておりますでしょうか？
「そもそもなんの備考欄だよ」という疑問が浮かぶかもしれませんが、私が今回お話するのは、様々なドキュメントにある備考欄全般に対する話です。
■備考はあくまで備考。だけど書くならしっかりと
プロジェクトの中で作成されるドキュメントは、大抵の場合、不特定多数の人、スキルの異なる人、立場の異なる人が見ることが多いです。
ドキュメントの中に記載された備考欄も、例外ではありません。
一つ例を挙げます。とあるテストケースを見たときに、こんな記述がありました。
結果：OK 備考：要確認
このテストケースは、実行者と結果確認者が別々の人が担当しており、どちらが書いたか全くわかりませんでした。
また、日にちが過ぎた後にこれを発見したため、当事者達も、どちらが書いたのか、また、何を要確認なのか、それが済んだことなのか、本当にOKなのか、全くわからない状態に陥りました。
このように、例え備考欄であっても、メモ書きのように使うことは控えておいたほうがよいです。
ではどう書けばよいのか？以下にポイントをまとめてみました。私の主観も入っているため、ご参考まで。
- 記述の最初に[yyyy/mm/dd 名前]を書き、誰がいつ書いたか明確にする
※yyyyはプロジェクトの長さによっては書かなくてもよい - 主観的な記述をしない。
- 誰に見られても理解してもらえるような記述にする。
- 「確認中」のような記述に対し、解を得られた場合、その記述は消さず、
「確認中 ⇒ 確認済、××さんから○○という回答を得た」のように、⇒で記述する - なるべく簡潔に書く(深く読み込まなければならない備考は書かない)。
- 備考に重要な情報を書きすぎない。あくまでも補足として扱う。
※記載内容の重要度は、本文 > 備考 になるように意識する
備考だからといって、油断して書いていると、後々見返したときに、わからなくなるので要注意です。ではでは。
