Rosarium

実践事例 / 公開物 / case

第3章 調査の起点を作るため、ファイルとクラスの役割を整理する

フォルダ・ファイル・クラスの役割をMarkdownで整理し、調査のための地図を作る。AIが構造の仮説を出し、人間がコードで検証する初動の進め方を示す。

公開:最終更新:

更新履歴

  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. 地図に調査結果を戻す

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

読み始める場所を決める

プロジェクトを開いても、多数のファイルやフォルダが並ぶだけでは、重要な処理や未使用コードを区別できない。いきなりすべての実装を読むのではなく、まず所在と役割を俯瞰できる情報を作った。

フォルダ構成、ファイル一覧、クラスの役割、機能単位の分類をMarkdownへ整理した。軽量なテキストで構造を表せるため、後の調査で分かったことも更新しやすい。

名前から得られる仮説と、コード上の事実を分ける

構造情報をGPTへ渡し、ディレクトリ名や命名規則から役割の仮説を出させた。例えば、次のような構成なら、層ごとの分担を調べる起点になる。

src/
api/
service/
repository/
config/

これは構成例であり、名前だけで実際の設計を確定できるわけではない。controller、service、repositoryという名称があっても、その責務は実コードで確認する必要がある。

AIは探索の候補を整理し、人間はコードで検証する。この順序により、仮説を完成した仕様と取り違えずに、どこから調べるかを絞れた。

地図に調査結果を戻す

この段階で得られるのは、プロジェクト全体の位置関係と、調査の起点である。各クラスの実際の処理、呼出し関係、未使用かどうかは、次のコード調査で確かめる。

位置と確認済みの役割を一つずつ対応させることで、調査結果が次の探索にも使える。次章では、作成した地図へ実装の意味を加える。