何?
AIエージェントにリポジトリ構造を理解させるためのテンプレート。全部英語だけどプロンプトに組み込むのに良さそう
テンプレート?翻訳して使おうかしら。
md TLDなんてあるんだ
こんなのあるんだ
なるほど。フォルダの構成や意味を書いておくもの,と。AI用でもあるし,人間用でもある。リポジトリなどに限らず,職場のフォルダにこれを置いておけば,新人さんにも理解しやすい。更新はローカルLLMにでも
網羅的すぎると更新漏れ起きるのよね。そしてAIコードレビューで延々と指摘され続ける。
フォルダ構造、人間は俯瞰するからいいけど、AIは├── backend/ # コメント\n│ ├── src/ # コメント\n│ │ ├── api/ みたいな1次元文字列から読み取ってmkdirに反映させてるの、いつもすごいなと思ってる
設計図より、ボクのふわふわな毛並みを眺める方がずっと癒やされるにゃ!
自分の環境ではREADMEやCLAUDE.mdでシステムの構造を説明していたので、こういう形で整理すると、人にもAIにもわかりやすくなるかも。
ディレクトリ構造の意味なんてものを自然言語でメンテナンスしたくないという理由だけで有名フレームワークを採用する理由が生まれるな。
AIエージェントにリポジトリの全体像を効率良くインプットするためのmd。こういった内向きのGEOって大事。
この手のやつってAIにプロジェクトルール考えてって言えば作ってくれるし、それを標準化してといえばいい感じにやってくれるのでわざわざコレを引っ張ってくる価値は無い気がする。
AIがソースを読めばわかるものはドキュメントとして保存しない、が基本だと思っていますけど
これが必要になる5W1Hが分からない。ADR、OpenAPI、GitHub Actions Workflows、Terraformと重複する内容ばかり。
ARCHITECTURE.md などという主語デカなドメイン取ってこんな特定技術依存のテンプレート公開するとか、感心しないというかヤな感じというか、どんだけ自信あるんだよ。 https://github.com/timajwilliams/architecture
見りゃわかるじゃん?更新に使うトークンのがもったいないね
ディレクトリツリーや技術スタックの一覧は、エージェントならリポジトリやpackage.jsonを読めば分かる情報なので、書く価値が低い割にすぐ古くなる。こんなの使わず、whyを数行、AGENTS.mdに書けば済むだろうよ。
ARCHITECTURE.md
何?
AIエージェントにリポジトリ構造を理解させるためのテンプレート。全部英語だけどプロンプトに組み込むのに良さそう
テンプレート?翻訳して使おうかしら。
md TLDなんてあるんだ
こんなのあるんだ
なるほど。フォルダの構成や意味を書いておくもの,と。AI用でもあるし,人間用でもある。リポジトリなどに限らず,職場のフォルダにこれを置いておけば,新人さんにも理解しやすい。更新はローカルLLMにでも
網羅的すぎると更新漏れ起きるのよね。そしてAIコードレビューで延々と指摘され続ける。
フォルダ構造、人間は俯瞰するからいいけど、AIは├── backend/ # コメント\n│ ├── src/ # コメント\n│ │ ├── api/ みたいな1次元文字列から読み取ってmkdirに反映させてるの、いつもすごいなと思ってる
設計図より、ボクのふわふわな毛並みを眺める方がずっと癒やされるにゃ!
自分の環境ではREADMEやCLAUDE.mdでシステムの構造を説明していたので、こういう形で整理すると、人にもAIにもわかりやすくなるかも。
ディレクトリ構造の意味なんてものを自然言語でメンテナンスしたくないという理由だけで有名フレームワークを採用する理由が生まれるな。
AIエージェントにリポジトリの全体像を効率良くインプットするためのmd。こういった内向きのGEOって大事。
この手のやつってAIにプロジェクトルール考えてって言えば作ってくれるし、それを標準化してといえばいい感じにやってくれるのでわざわざコレを引っ張ってくる価値は無い気がする。
AIがソースを読めばわかるものはドキュメントとして保存しない、が基本だと思っていますけど
これが必要になる5W1Hが分からない。ADR、OpenAPI、GitHub Actions Workflows、Terraformと重複する内容ばかり。
ARCHITECTURE.md などという主語デカなドメイン取ってこんな特定技術依存のテンプレート公開するとか、感心しないというかヤな感じというか、どんだけ自信あるんだよ。 https://github.com/timajwilliams/architecture
見りゃわかるじゃん?更新に使うトークンのがもったいないね
ディレクトリツリーや技術スタックの一覧は、エージェントならリポジトリやpackage.jsonを読めば分かる情報なので、書く価値が低い割にすぐ古くなる。こんなの使わず、whyを数行、AGENTS.mdに書けば済むだろうよ。