仕様書のないWebシステムを更新する方法
仕様書や担当者がいないWebシステムを、安全に調査・可視化し、テストと切り戻しを用意して更新する方法を解説します。
長く使われているWebシステムでは、「仕様書がない」「開発会社と連絡が取れない」「担当者が退職した」という状態も珍しくありません。
そのままでは更新できないように見えますが、稼働中のシステム、ソースコード、データベース、ログ、利用者へのヒアリングから、必要な仕様を段階的に再構成できます。
大切なのは、最初から完全な仕様書を作ろうとすることではありません。更新判断とテストに必要な情報を優先して集め、変更前の状態へ戻せる準備をしながら進めます。
最初にシステムを保全する
調査中の操作で状態を変えないよう、最初に現在の環境を保全します。
- ソースコードとアップロードファイル
- データベース
- サーバーとミドルウェアの設定
- Cron、バッチ、キューなどの定期処理
- SSL証明書、DNS、メール設定
- 利用中のアカウントと権限
- エラー・アクセス・操作ログ
バックアップを取得したら、復元方法と保存先へのアクセスも確認します。調査や更新は、可能であれば複製した検証環境で行います。
利用者から実際の業務を聞く
画面を見ただけでは、どの機能が重要か分かりません。日常的に利用している担当者へ、業務の流れを確認します。
- 誰が、いつ、何のために使うか
- 最初に入力する情報と最終的な成果物
- 止まると業務へ影響する機能
- 月末・年度末など特定時期だけ使う機能
- Excelやメールを介した手作業
- 他部署・取引先・外部サービスとの連携
- 過去に起きた障害と対応方法
利用者が「システムの外」で行っている作業も含めると、データの流れと重要度が見えやすくなります。
画面と機能を一覧化する
公開画面、管理画面、帳票、メール、API、定期処理を一覧化します。各機能について、入力、処理、出力、利用データ、権限を記録します。
すべてを同じ深さで調べるのではなく、利用頻度と業務影響で優先順位を付けます。使われていない機能を更新対象から外せれば、改修範囲を減らせる場合もあります。
ソースコードと依存関係を調べる
- 言語、フレームワーク、CMSとバージョン
- 外部ライブラリと管理方法
- 設定ファイルと環境変数
- データベース接続
- ファイルの保存場所
- メール、決済、地図、認証などの外部API
- ハードコードされたURL、IP、パス
- 本番環境で直接修正された形跡
Gitなどの履歴がなくても、ファイルの更新日時、コメント、ログ、バックアップとの差分から変更の痕跡を確認できます。調査開始時点のソースをバージョン管理へ登録すると、その後の変更を追跡しやすくなります。
データベースから業務ルールを読み取る
テーブル、カラム、外部キー、インデックス、データ件数を確認します。コード上の処理だけでなく、データベースのトリガー、ビュー、ストアドプロシージャに業務ルールが入っていないかも調べます。
個人情報や機密情報を検証環境へ複製する場合は、アクセス制限やマスキングを行います。
ログと通信から外部連携を見つける
仕様書にない連携は、ログやネットワーク通信から見つかることがあります。
- 外部APIへのHTTP通信
- メール送信
- SFTP・FTPによるファイル連携
- 共有フォルダーへの出力
- Webhookの受信
- 社内システムや会計ソフトとの連携
接続先、認証方法、実行時刻、失敗時の再実行方法を記録します。
最小限の再構成ドキュメントを作る
更新に必要な範囲から、次の資料を作成します。
- システム構成図
- 画面・機能一覧
- データと外部連携の流れ
- サーバー・ミドルウェア・ライブラリ一覧
- 重要な業務シナリオ
- テスト項目
- バックアップと復旧手順
- 未確認事項とリスク
分からないことを無理に断定せず、「未確認」「推定」「確認済み」を区別します。
現状の動きをテストとして保存する
更新前の環境で、重要機能の入力と出力を記録します。可能であれば自動テストにしますが、画面操作の手順書や期待結果だけでも有効です。
- ログインと権限
- 新規登録、編集、削除
- 検索、集計、帳票
- メール、ファイル、外部API
- 月次・年次の定期処理
- エラー時の表示と再実行
一度にすべてを変えない
OS、PHP、データベース、フレームワーク、画面を同時に変更すると、問題の原因を特定しにくくなります。影響を分けられる場合は、基盤更新、互換性改修、機能改善を段階化します。
各段階で、テスト、バックアップ、切り戻し条件を決めます。分からない範囲が大きい場合は、最初から固定見積りにせず、調査工程と実装工程を分ける方法もあります。
仕様書がなくても更新は進められる
必要なのは、完璧な過去資料ではなく、現在の動作と依存関係を確認できる環境です。現行システムを保全し、利用者・コード・データ・ログから情報を集めれば、更新に必要な仕様を再構成できます。
有限会社リッチアンドワイズでは、仕様書のないPHPシステムやWordPress、業務システムの調査から、更新計画、改修、検証、本番切替まで対応しています。