MYレビュー観点

はじめに

業務で第三者レビューアとして色々なドキュメントをレビューさせていただいております。
その際に私が特に気をつけて見ているところを挙げたいと思います。

全体

まずはどの工程のドキュメントについても気にしていることです。

$$
\begin{array}{|l|l|l|}
\hline
\text{No.} & \text{観点} & \text{ポイント} \\
\hline
\text{1} & \text{上位ドキュメントと整合性がとれている} & \text{各工程の担当者ごとに認識が異ならないように} \\
\hline
\text{2} & \text{表記ゆれがない} & \text{同上} \\
\hline
\text{3} & \text{体裁が整っている（文字の見切れがない、フォント種類やサイズサイズ）} & \text{同上} \\
\hline
\text{4} & \text{誤字脱字がない} & \text{同上} \\
\hline
\end{array}
$$

まぁ、普通ですね。
ここらへんは、レビュー前に作成者ご自身でチェックして解決しておいて欲しいところです。

設計

次に設計です。

$$
\begin{array}{|l|l|l|} \hline
\text{No.} & \text{観点} & \text{ポイント} \\ \hline
\text{1} & \text{入出力先が明記されている} & \text{影響確認をするため} \\ \hline
\text{2} & \text{条件に該当しない場合の結果が明確になっている} & \text{条件に一致しない場合の処理にて想定外の挙動をする恐れあり} \\ \hline
\text{3} & \text{変数やテーブルを使用する場合、初期化を考慮している} & \text{想定してない値が入っていて想定外の挙動をする恐れあり} \\ \hline
\text{4} & \text{論理名、物理名が記載されているか} & \text{どちらかしか記載されていない場合、正しく伝わらない場合がある} \\ \hline
\text{5} & \text{記載内容が処理単位でまとめられている} & \text{共通処理なのか個別処理なのかなど正しく伝わらない場合がある} \\ \hline
\end{array}
$$

設計に関しては、システム特有のルール等や癖？もあると思いますので、できれば有識者の確認をしてもらったほうが良いと思います。

テスト設計

さ、ついにテストに入ります。

$$
\begin{array}{|l|l|l|} \hline
\text{No.} & \text{観点} & \text{ポイント} \\ \hline
\text{1} & \text{改修前後の比較をする場合、確認する項目や観点が明記されている} & \text{実際は更新日など差異が出ることが多い。差異が出てもいい項目はテスト設計時に明確にしておかないと実行者が混乱する} \\ \hline
\text{2} & \text{テストの目的が明確に記載されている} & \text{例えば「フラグ確認」だけなど、何（処理のどの部分）を担保するテストなのかわからない記載は避けるべき。テスト漏れにつながる} \\ \hline
\text{3} & \text{テスト環境が明記されている} & \text{本番環境とかけ離れた環境でテストを行っても意味がない、また明記されていないと環境が原因の不具合に気づけなかったりする} \\ \hline
\text{4} & \text{テスト実施の条件（〇〇が設定済など）が明記されている} & \text{実行者が間違った条件でテストを実施してしまう可能性がある} \\ \hline
\text{5} & \text{テスト実施の手順が明記されている} & \text{実行者が間違った手順でテストを実施してしまう可能性がある} \\ \hline
\text{6} & \text{テスト実施の期待値が明記されている} & \text{典型的な良くない例は「正常に終了すること」。これだと何をもって正常に終了と判断できるのかわからない} \\ \hline
\end{array}
$$

テスト結果

よし、テスト実施が終わった！
と油断しないでください。ただ実行しただけではダメです。
きちんとエビデンスを残しましょう。

$$
\begin{array}{|l|l|l|} \hline
\text{No.} & \text{観点} & \text{ポイント} \\ \hline
\text{1} & \text{テストの終了条件を満たしている} & \text{たまにテストやり忘れてる人がいます。全テスト完了を終了条件にしている場合は全テストの結果が記載されているか確認しましょう} \\ \hline
\text{2} & \text{エビデンスの不足がないか} & \text{テスト計画時に取得すると定めたエビデンスが揃っているか確認しましょう} \\ \hline
\text{3} & \text{エビデンスのどこを確認して結果を判断したのかわかるようになっている} & \text{ただ画像を貼ってるだけで全員が結果を理解できるわけない} \\ \hline
\end{array}
$$

最後に

以上が私がレビュー時に見ている観点でした。
あくまで一例ですので、参画しているプロジェクトや対象のシステムによっては異なってくる部分もあるかと思います。

レビューアの人に参考にしてもらえると嬉しいですが、個人的にはレビューイの方に気にしていただいて貰えた方がレビューアとしても指摘が少なくなって楽になるので嬉しいなと。