「仕様書は一切ありません」「ソースコードにコメントもありません」——こうした状態での引き継ぎは、Webシステムの世界では珍しくありません。外注や個人開発のシステムには、ドキュメントが整備されていないものが多くあります。
では、仕様書がない状態からどのようにシステムを把握し、保守できる状態にするのでしょうか。実際の調査の進め方を紹介します。
ステップ1: サーバー環境の把握
まずシステムが動いている土台を確認します。OSのバージョン、Webサーバー(Apache/Nginx)、PHPのバージョン、データベース(MySQL/PostgreSQL)などを調べます。ここで古いバージョンが見つかることも多く、セキュリティリスクの把握にもつながります。
ステップ2: ディレクトリ構成の確認
ソースコードのディレクトリ構成を見ると、フレームワークや開発スタイルがおおよそ把握できます。Laravelであれば`app/`や`routes/`の構成から機能の概要がわかりますし、独自フレームワークの場合はエントリーポイントを特定するところから始めます。
ステップ3: データベース構造の確認
テーブル定義を確認することで、システムが扱っているデータの種類と関係性が見えてきます。テーブル名やカラム名が意味を持っていれば、業務フローを推測する手がかりになります。
ステップ4: 実際の画面と照らし合わせる
本番環境の画面を触りながら、コードの対応箇所を特定していきます。URLのルーティングからコントローラーを追い、画面の動きとコードを結びつけることで、全体像が見えてきます。
ステップ5: ドキュメントに残す
把握した内容をドキュメントとして整理します。今後の保守担当者が参照できる状態にしておくことで、次回以降の対応コストを下げることができます。
時間はかかるが、必ずゴールはある
仕様書なしの引き継ぎは、手間と時間がかかります。ただし、コードは嘘をつきません。丁寧に読み解いていけば、必ずシステムの全体像は把握できます。重要なのは焦らず、順序立てて進めることです。