【あるある】コードレビューで指摘された箇所、実は仕様変更されていた
こんばんは！IT業界で働くアライグマです！
エンジニアなら誰しも経験したことがあるのが、コードレビューでの指摘が実は仕様変更によるものだったというケースです。
しっかりと要件を満たしているつもりだったのに、「ここ、違うんじゃない？」と言われてしまい、調べてみると 仕様がこっそり変わっていた という事態に直面したことはありませんか？
これは決して珍しいことではなく、特に開発がスピーディーに進む環境では ドキュメントの更新が追いつかない ことが原因で起こりがちです。
今回は、この「コードレビューで指摘されたけれど、実は仕様変更されていた」という状況について、なぜ起こるのか、どう対処すればよいのか を詳しく掘り下げていきます。
仕様変更に気づかずレビュー指摘される理由
仕様変更によるレビュー指摘は、主に コミュニケーションのズレ から生じます。
どのような原因があるのかを見ていきましょう。
口頭ベースの仕様変更
スタートアップや小規模なチームでは、仕様変更が会話の中で決まる ことが多いです。
「この画面の挙動、やっぱりこうしよう」
「○○さんと話して、こっちの方が良いってなったよ」
こうした変更はドキュメントに残されず、開発者が知らぬ間に決定されることがあります。
仕様書・チケットの更新漏れ
仕様変更が正式に決まっていても、ドキュメントやタスク管理ツールの反映が遅れる ことがあります。
開発者は 古い仕様をもとに実装 し、それを知らないレビュー担当者が「ここ違いますよ」と指摘する、というパターンです。
変更の伝達が属人的
「仕様変更の連絡を特定の人だけが受けていた」
「プロダクトオーナーと一部のエンジニアだけで決めていた」
このように、仕様変更が開発チーム全体に伝わっていない こともよくあります。
レビュー時に仕様変更の有無を確認する方法
こうした 仕様変更のズレによる無駄な指摘 を減らすには、開発者・レビュー担当者ともに 仕様変更がないかを意識的に確認する 必要があります。
PR（プルリクエスト）に仕様の背景を記載する
「この変更は、○○の仕様変更に基づいています」と明記することで、レビュー担当者も仕様変更を前提にチェック できます。
特に大きな仕様変更がある場合は、関連するチケットやドキュメントのリンクを添えると、よりスムーズです。
変更点をレビュアーと事前にすり合わせる
「このPRの主な変更点は〇〇です」と、事前にレビュー担当者と 軽く認識をすり合わせる だけでも、指摘のズレを減らせます。
仕様変更がないかを質問する
もし指摘を受けた場合でも、「この仕様、最新の状態でしょうか？」と一言確認するだけで、無駄な修正を防げます。
仕様変更があるなら、それをチーム全体に共有する意識も大切です。
仕様変更をチーム全体に伝える工夫
仕様変更によるトラブルを防ぐためには、チーム全体で情報共有を徹底する ことが重要です。
仕様変更の記録を明確にする
仕様変更があった際には、以下のような形で記録を残すことが理想です。
- チケット管理ツール（Jira、Trello、Backlogなど）にコメントを残す
- ドキュメント（Notion、Confluenceなど）を更新する
- SlackやTeamsのチャンネルで共有する
仕様変更の共有ルールを決める
仕様変更をチーム内に確実に伝えるために、共有ルールを明確にしておく のも効果的です。
たとえば、
- 仕様変更が発生したら、必ずチームの定例会で共有する
- 仕様変更を担当者だけでなく、エンジニア全体に通知する
といったルールを決めておくと、情報の伝達漏れを防げます。
まとめ
コードレビューでの指摘が、実は仕様変更によるものだった という経験は、エンジニアなら誰しも一度は経験することです。
この問題を防ぐためには、
- 仕様変更を明確に記録し、チーム全体に伝える
- PRやレビュー前に、仕様変更の背景を共有する
- 指摘を受けたときに、仕様変更の有無を確認する
といった工夫が必要です。
コミュニケーションを円滑にし、「あれ、仕様変わってたの？」という無駄なやり取りを減らす ことで、開発の効率を高めていきましょう。
あなたのチームでも、ぜひ実践してみてください！