【製品の品質はSEの命】：クロスチェックとレビューの記載方法の実践ポイント
2025年1月入社のT.Nと申します。
タイトルにもある通り製品の品質はSEの命です。
品質の悪い製品を1回でも出してしまうと、製品への信用度が落ちてしまい
最悪の場合、契約が打ち切られることも(ﾟＡﾟ;)ｺﾞｸﾘ
そんなことにならないために、製造後のクロスチェックがあります。
今回はクロスチェックとレビューの記載方法、作業のポイントを
実体験を基に記事にしようと思います！
■クロスチェックとは
製造した成果物に対して、検証の制度や信頼性を高める手法の一つです。
■クロスチェックのメリット
・精度の向上
別視点からのチェックにより、単独では見落としがちなミスを発見しやすくなります。
例えば、専門家によるチェックや、別のツールを用いたチェックなど、
複数の観点から確認することで、より正確な結果を得られます。
・見落としの防止
1つのチェック方法だけでは見つけにくいエラーや、特定の条件下でのみ発生する問題を、
別の方法で確認することで発見できます。
・客観性の向上
複数の人がチェックすることで、主観的な判断による偏りを減らし、客観的な評価が可能です。
■クロスチェックのデメリット
・時間とコストの増加
チェック作業が複数回になるため、その分、時間とコストがかかります。
特に、専門的な知識やスキルが必要な場合は、その影響が大きくなる可能性があります
・コミュニケーションコスト
異なる部署や専門分野の人との連携が必要になるため、
部署間のコミュニケーションの壁が課題となる場合があります
・チェック疲れ
同じ内容を何度もチェックすることで、チェック担当者が疲弊し、
集中力が低下する可能性があります
・過信によるミス
チェック担当者が、自分のチェックを過信し、ミスを見落としてしまう可能性があります
■クロスチェックする際のポイント(新規対応)
1.テストの項目数が足りているか確認する。
メッセージを出力する処理がある場合、すべてのメッセージが正常に出力されているか、項目数がメッセージの数と同じか確認する。
お客様側で設定できる箇所で、もし誤りがあった場合、異常終了(意図した終了)にできているか確認する。
※例：お客様側で文字列型を設定する仕様がある場合、文字列型ではなく数値型を入れた場合どうなるかなど。
100%間違いが発生しない場合を除きすべてのパターンを考える。
もし項目数が足りなかった場合、再度テストを実施して頂くようにテスト作業者に依頼しましょう。
■クロスチェックする際のポイント(改修対応)
1.変更前と変更後の仕様書を比較して、変更箇所をチェックし、洗い出す。
※変更箇所がわかれば、このあとのクロスチェックがラクになります。
2.テストの項目数が足りているか確認する。
観点として、修正箇所に対する影響範囲のテストが行われているかが大事になります。
1つの処理を修正した場合でも、影響範囲によっては修正箇所以外の再テストを実施する必要があります。
もし項目数が足りなかった場合、再度テストして頂くようにテスト作業者に依頼しましょう。
■クロスチェックする際のポイント(新規、改修)
1.製造した成果物に今回必要な処理が入っているか確認する。
処理が抜けている場合、バグの原因になるのですぐに製造者に報告しましょう。
2.製造した環境とは別の環境でも実施できるか確認する。(別環境が存在する場合)
製造した環境にしかないものを使用して作った場合、客先環境に適用した際、動かない可能性があるため、問題が無いか製造者に確認しましょう。
別環境が存在しない場合は、製造前と製造後で実施環境が変わっていないかを確認する。
製造対象外が変更されていた場合、不正な動作が行われている可能性があるため、問題が無いか製造者に確認しましょう。
3.成果物として添付されるエビデンスが正しものかどうか確認する。
現時刻を処理内で使用するテストしているが、テスト時の時刻が写っていないなど、
エビデンスとして不正なものが無いか確認する。
※エビデンスが不正なものはテスト出来ていないのと同じなので、厳重に確認する必要があります。
4.実際に自分が対応するときと違う点があるか確認する。
対応する人によって作業の順番、製造の方法が異なります。
製造されたものが正しく動作するかのチェックも必要ですが、自分が対応した場合、
どんな方法で製造するか、どんな内容でテストするか考え、異なっている箇所を探してみましょう。
異なっている場所は、何故その処理が入っているのか、逆に処理が足りていないのではないかが見えてくると思います。
■以上がクロスチェック作業で大切にしていたポイントになります！
ここまでチェックして見逃すことはほぼありません。
■■レビューの記載について
■始めにレビューとは・・・製品開発の各段階で、設計書、コーディング内容、テストエビデンスなどの成果物を評価し、
設計上の問題点や改善点を指摘することで、製品の品質向上やコスト削減、効率化を図る活動です。
※クロスチェック時に発見した指摘内容をテキストにまとめて、作業者に修正してもらいます。
■レビューを記載する際のポイント
1.修正箇所を記載する。
ソースコードであれば何行目の記載が誤っているか、テストエビデンスであればテスト番号を記載してあげると修正するときに作業者が困りません。
※修正内容だけの記載だと、誤った箇所を修正される可能性があるため、書いたほうがよいと思います。
2.修正対応内容を細かく記載する。
「誤っているので修正してください。」だけの記載だと何が誤っているのか、どう修正すればよいのかが不明です。
作業者がレビューだけを見てすぐ修正出来るようにしてあげると、その後の作業速度が上がります。
3.横展開が必要か記載する。
指摘を記載する際に、他の箇所でも同じミスが無いか調べて記載しましょう。
また、修正箇所が多い場合は「※横展開必須」などを記載することで、指摘箇所が1つでないことが作業者にも伝わります。
参考までに上記ポイントを押さえた記載例を作成しました。
(記載例)
詳細設計書
10行目
基本設計にはリンゴと記載されているが、
詳細設計ではレモンになっている。
レモン→リンゴに修正して下さい。
※横展開必須
4.不明な箇所は質問する。
「処理の意味がわからない(何故その処理があるのかわからない)」「テスト項目の意味がわからない(テスト内容が重複しているように見える)」など
チェックしている時に不明だったことは質問しましょう。
※もしかすると「不要な処理が入っている=処理時間を短縮できる」、「テストが不要=テスト時間の短縮」などがあるかもしれません。。
以上がレビューを記載する際のポイントになります。
レビューするときはその後の作業がスムーズに進められるように記載しましょう！
クロスチェック、レビューの作業ポイントをいくつか書かせていただきました。
これからクロスチェック、レビューを実施するときは本記事を思い出していただけると幸いです。
更なる品質向上を目指して、今後とも頑張っていきましょう！！
