このドキュメント群は 4区分 に分かれる。詳細は ドキュメント構成.md を参照。
Wiki.js でも読めます: wiki.keinafarm.net/butlerlayer/README
— ブラウザ・タブレットから横断検索付きで閲覧できます。
全プロジェクト一覧は wiki.keinafarm.net から。
| 文書 | 役割 |
|---|---|
| マスタードキュメント.md | 継続開発の判断基準(設計原則・責務境界・配置ルール・不変条件) |
| vision/00_ビジョン定義書.md | 最上位目的・思想・価値判断 |
| reference/01_アーキテクチャ定義書.md | コンポーネント構成・ガバナンス |
| reference/02_契約通信仕様書.md | Task/Result Contract の完全仕様 |
| reference/03_実行SOP仕様書.md | SOP実行・Step kind・teach フォーマット |
| reference/04_データ運用仕様書.md | SQLite スキーマ・冪等性・KPI |
| reference/05_Brain動作原則.md | Brain が守るルールの詳細 |
| 文書 | 役割 |
|---|---|
| 本ファイル(README.md) | 入口案内。区分と読む順序を案内する |
| ドキュメント構成.md | 文書構成のメタ定義。4区分の定義・各文書の責任・更新ルール |
| 文書群 | 役割 |
|---|---|
| capabilities/ | 個別スキルの実装仕様 |
| roadmap/ | 将来計画(現在の設計正本ではない) |
| history/ | 実施記録・検討経緯(過去の記録) |
| archive/ | 旧版保管(参照専用) |
| 文書 | 役割 |
|---|---|
STARTUP_CONTEXT.md(リポジトリルート) |
前回セッションの直近進捗・TODO・設定値の再開用キャッシュ |
設計哲学を先に理解し、そのあとで実務再開すること。
再開キャッシュ(STARTUP_CONTEXT.md)を先に読むと、進捗に意識が引っ張られ設計原則を見失いやすい。
1. 本ファイル(README.md) — 全体の地図を把握する
2. マスタードキュメント.md — 何を守るべきかを理解する
3. vision/00_ビジョン定義書.md — なぜそのルールがあるかを理解する
4. reference/ 群(必要な文書だけ) — どう実装されているかを確認する
5. capabilities/(必要な場合のみ) — スキル固有の詳細
6. STARTUP_CONTEXT.md — 今どこで止まっているかを確認する(実務再開時)
最初に読む:
マスタードキュメント.md — 設計原則と委任ルールを把握するreference/05_Brain動作原則.md — Task Contract の書き方と禁止事項必要な時だけ読む:
reference/02_契約通信仕様書.md — Task Contract の詳細仕様capabilities/*/仕様書.md — 特定スキルを使う時vision/00_ビジョン定義書.md — 「なぜこのルールか」を理解したい時読まなくてよい:
reference/01_ 03_ 04_ — 実装者向け仕様書roadmap/ history/ archive/ — 実務には不要最初に読む:
マスタードキュメント.md — 配置ルールと責務境界を把握するvision/00_ビジョン定義書.md — 設計哲学と思想reference/01_アーキテクチャ定義書.md — コンポーネント構成実装時に参照する:
reference/02_ 03_ 04_ — 契約・SOP・DB 仕様capabilities/*/仕様書.md — スキル追加の参考例読まなくてよい(通常):
reference/07_ 08_ — KPI 評価・モデル選定(運用判断の記録)history/ archive/ — 過去記録