継承した大規模で文書化されていないコードベースを理解するにはどう進めますか？

Question

Accepted Answer

継承した文書化されていないコードベースに対面したときは、すべてのファイルを上から下まで読み通したり、汚く見えるものをリファクタリングしたりする衝動に抵抗してください。まだ理解していない状態で、誤解に基づいた早期のリファクタリングは障害の原因となります。目標は、推測ではなく実際の動作から、素早く正確な心的モデルを構築することです。

## 実践的なアプローチ

- **まずローカルで実行してみる。** ビルドして実行することで、スタック、依存関係、セットアップの課題がわかり、ロジックを読む前に全体像が見えます。
- **実際のユーザーフローを端から端まで追跡する。** 具体的なもの（ログイン、チェックアウト、レポートなど）を選んで、エントリーポイントからデータベース、そして戻るまでを追跡します。1つのフローを深く理解することは、10個のフローをさらっと見ることより価値があります。
- **データモデルを読む。** スキーマとコアドメインオブジェクトは、システムが実際に何をしているのか、概念がどのように関連しているのかを、コードよりも正直に明かします。
- **エントリーポイントを見つける。** ルート、コントローラー、メッセージコンシューマー、cronジョブ、main関数。これらはシステムへの入口です。
- **テストとログで動作を確認する。** ログ行またはブレークポイントを追加して、推測ではなく現実を観察します。既存のテストは意図した動作を文書化しています。
- **それを知っている人に話を聞く。** その道を通った人との30分の会話は、何日分の調査を節約できます。「何」ではなく「なぜ」を聞きましょう。
- **進みながらマップを書く。** モジュール、フロー、落とし穴を記した実行中のドキュメントは、あなたの努力を次の人と未来のあなたが再利用できるものに変えます。

## 避けるべきこと

理解する前にリファクタリングしないでください。コメントを動作より信じないでください。システム全体を一度に頭に入れようとしないでください。重要な部分について深く理解することが、すべての場所について浅く広く理解することより優れています。

## なぜ重要なのか

ほとんどのエンジニアリング業務は、他の誰かが書いたコード内で行われます。見知らぬシステムの心的モデルを素早く安全に構築できるテックリーダーは、チーム全体を前に進め、仕事の範囲を正確に把握し、まだ理解していないものを変更するという高くつく間違いを避けることができます。