Rosarium

実践事例 / 公開物 / case

第1章 仕様を答えられない状態から、復元すべき情報を決める

UI中心の古い仕様書では問い合わせに答えられなかった背景を示す。廃止できないシステムを使い続けるため、コード・実動作・既存知識から現行仕様を再構成する出発点を説明する。

公開:最終更新:

更新履歴

  1. 公開

ai / 設計 / リファクタリング / レガシー / rag

読む目的: 自然言語サービス・RAG・ナレッジ / AI × ソフトウェア開発 / 事例・実務

このBookの目次(全12章)
  1. 全体構成
  2. 第1章 仕様を答えられない状態から、復元すべき情報を決める
  3. 第2章 対象システムの変更を妨げる構造と知識の不足を整理する
  4. 第3章 調査の起点を作るため、ファイルとクラスの役割を整理する
  5. 第4章 コードから仕様と依存関係を復元する
  6. 第5章 処理の流れを復元し、変更影響を追えるようにする
  7. 第6章 人が読む仕様とAIが使うKnowledgeを分ける
  8. 第7章 UI操作と内部処理を結び付け、操作結果を追えるようにする
  9. 第8章 復元したKnowledgeを、根拠を確認できるQAへつなぐ
  10. 第9章 正しさ・出典・回答拒否から、QAの利用可否を評価する
  11. 第10章 評価結果をKnowledgeと回答範囲の改善へ戻す
  12. 第11章 仕様変更に追従できるKnowledge更新フローを作る
  13. 第12章 QAで暗号処理を調査し、人間の変更判断へつなぐ
目次
  1. 廃止できないシステムで、仕様の問い合わせに答えられない
  2. 調査のたびに答えを探し直す構造を変える
  3. 全面刷新より先に、理解と変更の材料を作る

現在位置:第1章・全12章

廃止できないシステムで、仕様の問い合わせに答えられない

担当したのは、約20年前に当社の中心的なソフトウェアとして開発された、多機能なシステムだった。独自の機能を長年使う利用者・愛用者が多く、終了を検討したことはあっても、単純には廃止できなかった。

担当して間もなく、社内から仕様について問い合わせを受けた。

既存仕様書には画面、ボタン、操作手順の説明があったが、内部構造や処理フローはほとんど書かれていない。古い記述も更新されておらず、その日のうちに資料だけで明確な回答をすることはできなかった。

結局、ソフトウェアを実際に動かして挙動を確認する必要があった。現在の担当者も詳細を把握できず、長期間担当している委託作業者だけが知る情報もあった。仕様書が存在していても、現行仕様へ到達できる状態ではなかった。

調査のたびに答えを探し直す構造を変える

内部仕様が社内で共有されていないため、小さな調査や軽微な変更も委託へ依存していた。人件費の高騰もあり、委託費削減は部門の課題だったが、問題は費用だけではない。社員の調査・理解にかかる時間や、意思決定の遅れも積み重なっていた。

既存仕様書を整形し直すだけでは、欠けている処理や背景は埋まらない。

ソースコードを確認の起点とし、UI、実動作、既存資料、担当者の知識を合わせて、現在の仕様と構造を再構成することにした。

古い資料は調査材料として使い、記載があることだけを正しさの根拠にはしなかった。

全面刷新より先に、理解と変更の材料を作る

新規開発や全面刷新を先に進めても、何を維持し、何を変えるかを説明するには現行システムの理解が必要になる。

そこで、まず調査結果を他の人も参照できる形に残し、仕様の確認や変更の検討へ再利用することを優先した。

目標は、委託費だけでなく、社員の調査・理解・判断にかかる工数を減らすことだった。単に仕様を抽出するのではなく、必要な情報を探し、根拠を確認できる状態を作る。

次章では、そのために何を把握する必要があったかを、対象システムの構造から整理する。