鉄則087 疲労困ぱいで不機嫌な人に読まれると思え。報告書は極力読みやすく

「ソフトウェアテスト293の鉄則」より

プロジェクトの終盤では、開発者は膨大なバグを修正し、
製品を完成させるためにかなりの時間の残業をしているのが一般的だ。
このような厳しいプロジェクトは皆が、睡眠時間も少なく、
ストレスと過度の興奮状態にある。
そんな状態の開発者にも理解しやすい障害レポートを書く必要がある。

何をどうやって問題を確認したか、さっぱりわからない報告が届くと
「何をしろと言うのだ」と、途方に暮れるよね。
この鉄則には、障害レポートを書く際に気をつけることとして

• 1ステップずつ、番号を振って
• 何も省略しない
• 余白をうまく使う
• 何が起こったのか、何が起きると期待していたのかを指摘する
• 短く、簡潔に

などなど。
あと、

• 語調を荒げない
• 誤解を招かないように、冗談などは書いてはいけない

とあって、疲労困ぱいしてるときは、冗談、通じなくなるから
ほんと、冗談は書いちゃいけない、と思う。
すごく納得。