この記事の要約
システムの引継ぎや保守で行う調査は、システムの仕組みや状態を把握し、安全な改修と適正な見積もりにつなげるための工程です。ドキュメントやソースコード、データベース、サーバー、外部サービスとの連携などを確認します。設計書などが残っていなくても、システムの調査と関係者へのヒアリングで把握できます。
既存システムの引継ぎや保守を依頼したところ、見積書に「調査費用」という項目があり、「調査って何をするんだろう」と疑問に感じたことはないでしょうか。
システムの引継ぎや保守のご相談では、お客様からこうしたご質問をいただくことが少なくありません。
確かに、見た目には何も変わらない「調査」という工程に、なぜ時間やコストがかかるのかは分かりにくいかと思います。
しかし、システムの引継ぎや保守を行ううえで、事前の調査はとても重要です。
システムがどのような仕組みで動いているのか、どのような機能があり、どこを変更すると影響が出るのか。こうした情報を把握しておかなければ、安全に保守や改修を進めることはできません。
では、システムの調査で具体的に何をしているのでしょうか。また、設計書や仕様書などのドキュメントが残っていない場合でも、調査はできるのでしょうか。
今回は、システムの引継ぎや保守で行う「調査」の必要性や具体的な作業内容について解説します。
1.調査は必要?
システムの引継ぎや改修を行う際、事前の調査は必要なのでしょうか。
調査をせずにシステムの改修や運用を行うのは、精密検査を受けずに手術をしたり、健康診断を受けずに健康管理をしたりするようなものです。体の状態を把握しないまま治療や健康管理を行えば、思わぬ問題が起こるかもしれません。
システムも同じです。安全に改修を行ったり、安定した運用を続けたりするためには、まずシステムの仕組みや状態を把握する必要があります。
また、システムの仕組みや状態が分からなければ、改修に必要な作業量や費用を正確に見積もることが困難です。想定外の作業が発生するリスクまで含めるため、見積もりが高額になってしまうこともあります。
逆に言えば、最初にしっかりと調査を行うことは、発注者側にとって大きなメリットです。
現状を正確に把握できれば、無駄なコストを抑えた適正な見積もりを出せるようになります。また、潜在的なセキュリティリスクや老朽化している箇所を早期に発見できるので、将来のシステム障害を未然に防ぐことにもつながります。
2.そもそも調査では何をしているの?
では、開発会社は調査で具体的にどのような作業を行っているのでしょうか。
システムは、ブラウザに表示される画面だけでなく、裏側のプログラムやサーバー、外部サービスなど多くの要素が絡み合って動いています。
引継ぎや保守の調査では、こうした要素を調べて、システムの全体像を把握していきます。
ドキュメントの確認
設計書や仕様書、運用マニュアルなど、システムに関係するドキュメント(記録物や文書)を確認します。
ドキュメントが残っている場合でも、書かれている内容と実際に動いているプログラムに違いがないかを検証します。
ソースコードの解読
システムを動かしているプログラム(ソースコード)を確認します。
単にプログラムを読むだけでなく、次のようなことを調べます。
- PHPやLaravelなど、使用されているプログラミング言語やフレームワーク
- プログラムの書き方や命名規則など、独自の開発ルール
- 画面のボタンを押したとき、最初にどのプログラムが実行されるのか
- そこから別のプログラムがどのような順番で呼び出されるのか
- データの受け渡しや処理の流れ
- 他の機能と共通で使用しているプログラムの有無
さらに、プログラムの内容だけでなく、開発者のパソコン上でシステムを動かすためのローカル環境の構築手順や、自動テストの有無、Gitなどによるバージョン管理の運用ルールまで把握します。
データベース構造とバックアップ体制の確認
システムで扱うデータがどのように保存されているかも、重要な調査項目です。
例えば、顧客情報や注文情報、売上データなどがデータベースのどのテーブルに保存されているのか、テーブル同士がどのようにつながっているのかを確認します。
また、データの保存形式や項目、データ同士の関連性、更新・削除の仕組みなども調べます。
あわせて確認したいのが、万が一の障害に備えたバックアップの取得方法や頻度、データ破損時の復元手順です。
サーバー・インフラ環境の把握
システムが動いているサーバーや、その周辺のインフラ環境についても調査します。
- サーバーの契約先や契約内容
- サーバーのOSやミドルウェアのバージョン
- ドメインの契約先や管理状況
- DNSの設定内容
- SSL証明書の種類や有効期限
- サーバーへのログイン方法やアクセス権限
- サーバーの構成やネットワークの接続状況
- ステージング環境やテスト環境の有無
どこに何の契約があり、誰が管理していて、どのような権限で操作できるのかを整理しておくことが重要です。
外部サービスとの連携チェック
システムは、次のような外部サービスと連携していることがあります。
- クレジットカードなどの決済システム
- GoogleやSNSなどを利用したログイン機能
- メール配信サービス
- 外部の顧客管理システムや会計システム
- 地図情報や住所検索などの外部API
また、連携に必要なアカウント情報やAPIキー(外部サービスを利用するための認証情報)がどこで管理されているか、利用期限や権限に問題がないかなども調べます。
外部サービスとの連携を見落としたまま改修すると、決済ができなくなったり、メールが送信されなくなったりする可能性もあります。
バッチ処理(定期実行プログラム)の確認
バッチ処理とは、あらかじめ決められたタイミングで自動的に実行されるプログラムのことです。
「毎日深夜に売上を集計する」「定期的にデータを同期する」といった処理がどこに設定されていて、いつ、どのような条件で実行されるのかを確認します。
Linuxのcron(クロン)など、定期実行の仕組みを利用している場合は、その設定内容も調べます。
処理がエラーで止まったときの通知方法や、失敗したときのリカバリ(再実行)手順を把握しておくことも重要です。
その他の運用・管理状況の確認
さらに、次のような項目も確認します。
・監視・ログ・アラート体制
システムに異常が発生したとき、どのように検知され、誰に通知されるのか。操作履歴やエラーの記録はどこに残るのか。
・セキュリティ対策
アクセス制限や認証の仕組み、脆弱性への対応状況、ソフトウェアの更新状況など。
・非機能要件
システムの処理速度や同時アクセス数、障害発生時の復旧目標など、機能そのもの以外に求められる性能や品質。
・既知の不具合や技術的負債
以前から把握されている不具合、修正が必要だと分かっている箇所、古い技術や複雑なプログラムなど、今後の保守で注意が必要な部分。
ここまで紹介したように、システムの調査で行う確認作業はさまざまです。
ただし、調査にかかる時間や費用は、システムの規模や構造、開発時の状況などによって大きく異なります。
構造が比較的シンプルで、仕様書や設計書などの資料が最新の状態に保たれているシステムであれば、スムーズな調査が可能です。
一方、複雑なシステムで、ドキュメントがなかったり更新されていなかったりする場合は、実際のプログラムを確認しながらシステム全体の仕組みを把握する必要があります。そのため、調査の負担が大きくなります。
さらに、古い技術や現在ではあまり使われていない開発環境が採用されている場合、調査そのものに専門的な知識や追加の作業が必要になることもあります。
このように、調査の作業量は、プログラムの行数やシステムの規模だけで決まるものではありません。どのような仕組みで作られ、どの程度の情報が残っているかによって、必要な作業は変わります。
そのため、調査費用はシステムの状況や調査する範囲に応じて決まります。
3.ドキュメントがなくても調査はできる?
「社内に仕様書や設計書が一切残っていない」というご相談をいただくことがあります。ドキュメントがなくてもシステムの調査は可能です。
もちろん、最新の設計書や仕様書が揃っていれば、調査のスピードや精度はより高くなります。しかし、システムの引継ぎでは、ドキュメントは必須ではありません。
前章でご紹介したように、エンジニアは実際のソースコードやデータベース、サーバーの設定などを調べます。こうした調査によって、資料がなくても、現在のシステムがどのような構造で動いているのか、その大部分を把握することが可能です。
ただし、プログラムを調べるだけでは分からない部分があります。
プログラムからは、どのような処理が行われているかは分かっても、なぜその処理が必要なのか、実際の業務でどのように使われているのかまでは正確に把握できないことがあります。
そこで有効なのが、システムを利用している担当者様や、これまで管理・開発に携わってきた関係者様へのヒアリングです。
システムを実際に利用している担当者様や管理者様にお話を伺い、日々の業務フローや運用方法、現在お困りの点などを教えていただくことで、プログラムの動きを詳しく把握できるようになります。
資料がないからといって、引継ぎや保守を諦める必要はありません。
現在のシステムを実際に調査し、必要に応じて関係者へのヒアリングを行うことで、システムを把握することは十分に可能です。
まとめ
既存のWebシステムを引き継いで保守や改修を行う際、「調査」は単なる下準備ではなく、プロジェクトを安全かつ確実に進めるための大切な土台となります。
最初にしっかりと調査を行うことで、お客様には次のようなメリットが生まれます。
・安心して改修を依頼できる
システムの構造や機能同士のつながりを把握し、既存機能への影響を確認したうえで改修を進められます。そのため、改修に伴う予期せぬトラブルや不具合を防ぐことができます。
・費用や納期の見通しが立つ
システムの現状や規模を把握してからお見積もりを作成するため、納得感のある費用やスケジュールをご提示できます。
・今後の運用がしやすくなる
システムの構造や課題が整理されることで、その後の保守対応や将来的な機能追加もスムーズに進められるようになります。
また、仕様書や設計書などのドキュメントが残っていなくても、システムの調査は可能です。
「以前の開発会社と連絡が取れなくなった」「システムの仕様が分からず、改修を依頼できない」「古いシステムを引き継いでくれる会社を探している」といったお困りごとはありませんか?
株式会社パパグラムでは、他社が開発したシステムの引継ぎや改修を行う「システム引受所」というサービスを提供しております。ドキュメントが残っていないシステムや、長年運用してきた古いシステムについても、まずは現状を調査し、今後の対応方法をご提案します。
システムの引継ぎや保守でお困りの方は、ぜひお気軽にお問い合わせください。