ARCHITECTURE.md

SYSTEM TEMPLATE FOR RAPID CODEBASE COMPREHENSION - HAVE YOUR AGENT TO FILL IN FOR YOUR REPO # Architecture Overview This document serves as a critical, living template designed to equip agents with a rapid and comprehensive understanding of the codebase's architecture, enabling efficient navigation and effective contribution from day one. Update this document as the codebase evolves. ## 1. Project

[zentarou]

網羅的すぎると更新漏れ起きるのよね。そしてAIコードレビューで延々と指摘され続ける。

[ynxdaz]

フォルダ構造、人間は俯瞰するからいいけど、AIは├── backend/ # コメント\n│ ├── src/ # コメント\n│ │ ├── api/ みたいな１次元文字列から読み取ってmkdirに反映させてるの、いつもすごいなと思ってる

[ngmy]

ディレクトリ構造の意味なんてものを自然言語でメンテナンスしたくないという理由だけで有名フレームワークを採用する理由が生まれるな。

[BOOOOOOOON]

これが必要になる5W1Hが分からない。ADR、OpenAPI、GitHub Actions Workflows、Terraformと重複する内容ばかり。

[devrabi]

AIがソースを読めばわかるものはドキュメントとして保存しない、が基本だと思っていますけど

[queeuq]

この手のやつってAIにプロジェクトルール考えてって言えば作ってくれるし、それを標準化してといえばいい感じにやってくれるのでわざわざコレを引っ張ってくる価値は無い気がする。

[yoiIT]

AIエージェントにリポジトリの全体像を効率良くインプットするためのmd。こういった内向きのGEOって大事。

[te2u]

自分の環境ではREADMEやCLAUDE.mdでシステムの構造を説明していたので、こういう形で整理すると、人にもAIにもわかりやすくなるかも。

[FreeCatWork]

設計図より、ボクのふわふわな毛並みを眺める方がずっと癒やされるにゃ！

[l_etranger]

なるほど。フォルダの構成や意味を書いておくもの，と。AI用でもあるし，人間用でもある。リポジトリなどに限らず，職場のフォルダにこれを置いておけば，新人さんにも理解しやすい。更新はローカルLLMにでも

[abcdefghijklmnopqrstuvwxy5]

こんなのあるんだ

[fh477ehj8890]

md TLDなんてあるんだ

[ys0000]

テンプレート？翻訳して使おうかしら。

[nguyen-oi]

AIエージェントにリポジトリ構造を理解させるためのテンプレート。全部英語だけどプロンプトに組み込むのに良さそう

[Galaxy42]

何？