🔎

[レビュー] 指摘漏れを減らす方法

2024/08/25に公開

はじめに

2024/04 月に新メンバーが PJ に加わりレビューをする機会が増えました。
レビューで漏れが発生しないように下記書籍を購入しました。
本記事は、書籍の内容をもとに自分の PJ なら低コストで導入できる内容を意訳して執筆しております。

下記立場の人が取り組んで欲しい内容を記載しております。

  • レビューを依頼する人
  • レビューを受ける人

前提

  1. レビューをする目的は、完璧なドキュメントを作成する事でなく、手戻り工数が大きい作業を見逃さないこと
  2. チーム全員が知らない/考慮できない問題を魔法のように見つける方法の話ではない

結論

レビューを依頼する人

1. 重大な問題を洗い出す

下記例のように大きな作業の手戻りやサービスの信用を失う問題を考えます

① 勤怠管理システムなら月末に入力作業や承認作業等でアクセス集中過多で勤怠管理システムが使えない

② クレジットカード決済ならポイント計算、クーポンの適応などで金額が合わない

2. シナリオを作成する

さきほどの重大な問題を見逃さない為にもシナリオを作成します
シナリオとは、レビューを受ける人が特に意識して確認して欲しい観点を指します。

① 勤怠管理システムなら月末に入力作業や承認作業等でアクセス集中過多で勤怠管理システムが使えない 1.アクセス集中過多対策されているのか? 2.アクセス集中過多対策はどの領域でどのような方法なのか? 3.その方法のメリット/デメリットとは? 4.何アクセスまで耐えられるのか?

② クレジットカード決済ならポイント計算、クーポンの適応などで金額が合わない 1.ポイント計算、クーポンの適応など支払い金額が変更されるイベントをすべて洗い出せているのか? 2.上記のイベントに対して何件のテストを行う予定なのか? 2.上記のテストに対して十分性を証明できるのか?

3. 誰にレビューして貰うかを決める

なんでもかんでも上司や先輩にレビューをお願いすればいいわけではない

下記例のように内容によってレビューして貰う人を決める

① マニュアルや作業手順書など誰でもわかりやすい文章や構成が求められる資料なら自分より経験が浅い人が適任かもしれない

レビューを受ける人

1. 修正工数やリスクが大きいシナリオから着手する

重大な問題を早く摘出し素早くフィードバックを行えたら、
それだけ納期までに時間に余裕を持つことができます。
また、シナリオを軽く目を通してレビューに必要な資料などを事前に準備する

もし、修正工数やリスクが同じぐらいなら下記の順番で対応する

2. シナリオを 1 件ずつ確認する

「どんな問題を検出すべきなのか?」を意識する為にシナリオを 1 件ずつ確認します。
レビューを依頼する人が記載してくれたシナリオを十分にクリアされているのかを確認します

3. 1 件のシナリオ確認が終わったら記録する

調べ終わったときに確認項目の提示や俯瞰して確認項目の漏れなどを見つけやすくなります。
また、併せて大まかな作業時間も記録しておくと今後の見積もり等で活用する事ができます。

おまけ

1.「など」

「など」に該当する要素が何かであるのかが明確ではない場合がある。
などに該当する要素はすべて書き出すか、「~を満たすもの」のように条件を記載する

2.「これら」「それら」

何をさしているのかが明確ではない場合がある。指し示す言葉に置き換える

3.「処理する」「対応する」

具体的に何をすればよいのかが明確ではない。
例えば処理であれば、演算や入出力などの内容を明示する

4. 「~を考慮して」「~を踏まえて」「~に基づいて」

どの程度加味するのかがはっきりしない。
加味する情報をどう利用するのかを具体的に書く

5. 「通常は」「基本的には」

「通常ではない」「基本的ではない」ことが何であるかが分からないケースが多い、それら例外のケースを具体的に示す必要がある

6. 「できる限り」「可能な限り」

どれくらいの許容範囲があるのか、単なる努力目標を示しているのかが明確ではない。
許容範囲を具体的に書く

7. 「十分な(十分に)」「余裕をもって」

どれぐらいで十分なのか、どれぐらいの余裕をもってなのかが分からない。具体的な数値を示す

8. 「すぐに」「ただちに」

まったく時間をおかない「直後」を指す場合と、対象の時間をおいてもよいことを表す場合がある。
切れ目なく連続させるのか。もしくは、どれだけの間隔をおいて良いのか、について具体機に明示する

9. 「現在の」「最新の」

どの時点において「現在」「最新」なのかが明確でない。そのタイミングを具体的に示す

10. 「現状通り」

現状が何であるかを、読み手が知っているとは限らない。現状についての説明を付けて加える

GitHubで編集を提案

Discussion