間違いだらけの設計レビュー 第3版 - 全体像と初版(2013年)と改訂版(2015年)の変更点

こちらで、改訂版からの追加や変更を紹介しました。
本記事は、まだ本書を読まれていない方向けに本全体の紹介をします。

本書はソフトウェアドキュメントのレビューの手順を解説した書籍です。多くの開発現場では、レビューは見よう見まねで「過去に有識者がチェックしていたから」「自分がレビューで見逃してテストで見つけて修正するのに苦労したから」といった経験から身につけていくと思います。しかし、それだと新しいチェックの方法が得られるペースが上がりません。

本書の全体概要
本書では、そのペースを上げるために、システマティックに実行するための方法を説明しています。まず、フェーズとしてレビューの準備、欠陥の検出、欠陥の指摘に分け、それぞれのフェーズで何をすべきかを解説しています。そして、レビューでの役割として、リーダー、レビューアー、作成者を設け、それぞれがやるべきことを手順として説明しています。初版を書くまでは、手順化をしている書籍や文章はなかったので、かなり苦労しました。最後に、レビューで検出すべき欠陥とそうでない(おもにテストで)検出すべき欠陥を優先順位付けして、どういうチェックの方法で欠陥を検出するかを大まかな方針として定め、「指針となるレビューシナリオ」というメモを書いてレビューアーと合意するための方法を書いています。

ここからは初版を読んでくださった方向けに改訂版で追記した内容の紹介です。

改訂版で追加した点
「指針となるレビューシナリオ」の手順の補足説明として、複数の事例の共通部分を取り出し、典型的な4つの着眼点を事例ベースで説明しています。40ページ分あります。改訂版というと修正箇所があったような印象ですが、主な変更はこの部分の補足です。この事例ベースの補足は、他の手順と比較してここの部分がわかりにくいという読者の方からの感想があったり、私も補足が必要と感じていたので、第1版から2年後の2015年の時点で私から出版社にお願いして実現しました。