巨大システムの調査用のドキュメント¶
このドキュメントは、巨大システムでリポジトリを横断的に調査するためのドキュメントであり、生成AIに読み込ませることを想定している。
- 次の表のようなディレクトリからシステムに関する情報を集める。
| ディレクトリ名 | 説明 | |
|---|---|---|
application |
アプリケーションに関するコード | |
document |
ほかのドキュメントツールで管理されているページをPDFなどとして管理。また、AIに自動生成したもらったマークダウン仕様書も管理。検討中の情報や古い情報が混じっている可能性があり、applicationやinfrastructureにおけるコードの情報が正しい。 | |
tasks |
タスクに関する情報 | |
infrastructure |
インフラストラクチャに関するコード |
- ほしい情報があれば教えて。
- 会話するなかで新しい情報や正しい情報が判明した場合、その都度
documentディレクトリにあるドキュメントの仕様書にマークダウンのアーキテクチャ図や仕様を追加したり、情報の誤りを修正して欲しい。