設計レビューの目的ってなんですか？
kindle unlimitedが2ヶ月99円のセールをやっていて連休ですし，何冊か読んでいます(これがAmazonの狙いか)．その中で今の自分にとってはピッタリな本がありました．
背景〜僕の今の立場〜
僕はサーバーサイドエンジニアで，開発する上で，API仕様書やその他システムに関しての資料が必要です．前まではそのようなドキュメント類の作成，更新はほとんどしておらずでレビューが多かったんですが，最近は自分で書く機会もかなり増えてきました．
自分でやってみてわかったんですが，他のページとフォーマットを揃えたりするのが意外と難しいのです．また，コードを書く前は「こんな感じで行けそうだな」と思っていても，実際やってみると「あれ？なんかこれ足りなくね？」となることもしばしばあり，ドキュメント整理について大きな課題を感じていました．
本書は主にレビュアーの立場について書かれていますが，ドキュメント作成側の人も読んでみるといいかもしれません(前20%くらいが大事なところで残り80%は流し読み，というかほぼ読んでません)．
間違ったレビュー
失敗レビューの典型例は次の3つです．
1. 思いつき
最も多い間違いで，レビュアーの間でどんな問題を指摘するかの方針が定まっておらず，思いついたままに指摘をしていくというものです．人それぞれ得意分野があるので，さほど重要なことでなくても「このグラフはこう書くべき」といった具合のレビューをしてしまったりします．
2. 数字合わせ
例えば1ページ当たり何個といったノルマを課せられたときによく起きます．例えば，1人2件指摘するだったら簡単なところだけを探してしまい，他に重要な問題があっても指摘しないといったことが起きます．
3. つるし上げ
ドキュメント作成者の人格を攻撃し，つるし上げるといった失敗レビューです．ドキュメントの間違いではなく，「ちゃんとやったの？」「ドキュメントに値しない」といったような言葉で作成者を攻撃します．そんなことを言われてしまったら作成者は，もちろん反発してしまいます．
レビューにはマインドも大事
レビュアーのマインドによって結果は大きく異なります．先ほど挙げたつるし上げはマインドの間違いに該当します．これはドキュメントだけでなく，プルリクなどにも言えると思います．プルリクのレビューで指摘されても，なんか抵抗というか修正したくないなぁと思ったことがあると思います．この辺りはレビュアーの言い方によっても左右される部分もあるので気をつけたいものです．
レビューの目的とは
レビューの目的は修正工数を減らすことです．設計した段階で問題が見つかるのと，単体テスト後あるいは結合期間中に問題が見つかるのとでは修正にかかる時間が異なる場合があります．もちろん早い段階の設計時に見つかった方が，軌道修正が効きやすく修正がより短期間で済みます．
一方で，あとでも先に発見できても修正工数が大差ないものもあります．そういう問題については時間も限りがあるので，レビューで必ずしも検出する必要はなさそうです．レビューでは，先に発見しておけば，修正工数が減らせるような問題の優先順位を上げておくべきです．
間違った問題検出の仕方
ここでは問題検出時のレビュアーの間違いについてです．本書では①人間関係の持ち込み，②作成者気分，③二兎追い，④時間切れ」の4つが挙げられていたのですが，ここでは前者2つについてみていきます．
1. 人間関係の持ち込み
レビューをするときはドキュメント作成者の顔を思い浮かべて，見る目を厳しくしたり甘くしたりしてしまいます．例えば，不仲な人やアドバイスをしても直らない人のレビューであれば，知らないうちに厳しくしてしまいがちです．逆に仲がいい人のドキュメントだと甘くなってしまう時もあります．
このように陥らない方法は，レビューの目的を再確認することです．「この指摘は修正工数を減らすことにつながるか？」を自問自答します．
2. 作成者気分
レビュー対象のドキュメントを読んでいて，全体的に問題が多いまたはフォーマットが整っていないので自分が一から作り直した方が良いとなるときがあるのではないかと思います．
ドキュメント作成のスキルが高い人が作り直すのは良いことだと思うかもしれません．しかしレビュアーの役割とは問題の検出であって，修正をするのは作成者です．レビュアーは問題の検出を優先します．どうしようもない場合は作り直す必要もありますが，今あるドキュメントをベースに修正したほうが工数が少なくすみます．
ドキュメント作成者側の気を付ける振る舞い
レビューは先ほど書いた「つるし上げ」でなくても，色々指摘されることはドキュメント作成者にとってはあまり気分がいいことではありませんし，思うこともあるはずです．
そのような場合でも，指摘内容についてはしっかり受け止めて，「ありがとうございます，助かりました」と前向きな態度をしたいものです．
指摘が多かったりすると「じゃあ，自分でやってくださいよ！」と抵抗というか反論というか感情が前に出て反論してしまいそうになるときもあると思います．しかし，こんなことを言ってもいい方向には行かないので冷静になって物事を捉えていきたいものです．
この記事が気に入ったらサポートをしてみませんか？