読者です 読者をやめる 読者になる 読者になる

Clean Documentという提案。-WACATE 2011 夏に参加してきました-

Testing

WACATEというソフトウェアテストのワークショップな合宿に参加してきました。
WACATE
WACATE2011 夏 ~誰がためにレポートはある~ 開催概要 - WACATE (ソフトウェアテストワークショップ)


今回は「インシデントレポートについて」ということで、仮想プロジェクトでつかわれているインシデントレポートの改善をしていく。というものでした。
6人のチームでワークショップをし、2日目に成果を提案資料として発表します。
個人的にはまとめとした「改善のテーマ」が気にいっています。


【Clean Document】


伝えたいことをストレートに伝える。無駄のないドキュメント。


これは僕が名付けた造語です。(Robert.C.MartinのClean Codeからもじりました)
発表資料を作成中にインシデントレポートの書き方ガイドラインを眺めていて思いつきました。


ソースコードが人から人へわたるものであり、人間が目を通すものである限り、シンプルで雄弁であることが要件になってくるように、
インシデントレポートが人から人へわたるものであり、コミュニケーションツールである限り、同じようにシンプルで雄弁であることが要件だと思うのです。


何かの言葉があると共通認識として持ちやすいと思っているので、僕はできるだけこの言葉を使っていきたいなぁーと思います。
なにかもっとキャッチーな言葉があればそちらでぜひ!
今後、もっと勉強してちゃんと要点をまとめた「Clean Document」という資料を発表できるようにしたいです。参考書籍など教えてもらえるとありがたいです><



「Clean Documentがどれくらい影響を与えているのか」についての確認方法は「対象ドキュメントを受けとってから一次作業完了までの経過時間」「対象ドキュメント記述メンバーに新規メンバーが参加したときにアウトプットされるドキュメント内容のバラつき加減」「レトロスペクティブ時のメンバーのリアクション内容」などになると考えました。



とても実りのあるワークショップでした。ありがとうございました!

広告を非表示にする