DESIGN.md
このファイルは設計のエントリポイントです。簡潔に保ち、docs/design-docs/ 配下のより詳細なファイルへのルーティングに使用してください。
目的
単一のチャット、スプリント、またはレビュアーの記憶を超えて存続すべき、永続的なプロダクトおよびシステム設計上の決定を記録する。
以下の場合にこれを読む
- 現在の設計哲学が必要な場合
- 新しいパターンを導入しようとしている場合
- どの設計上の決定が確定しており、どれがまだ未決定かを知る必要がある場合
正式な設計文書
docs/design-docs/index.md: 承認済み、提案中、非推奨の文書のインデックスdocs/design-docs/core-beliefs.md: プロジェクト全体のエージェントファーストなビリーフ
設計ルール
- 設計文書は小さく、最新に保つ。
- 意思決定領域ごとに1つの文書を優先する。
- 変更が設計文書に依存する場合、プランや仕様から設計文書にリンクする。
- 設計ルールが運用上重要になった場合、自動チェックに昇格させるか
ARCHITECTURE.mdを更新する。