You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-5Lines changed: 37 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,28 @@
1
1
# Agent Playbook Template
2
2
3
+
Agent Playbook Template is a portable governance framework for AI coding agents.
4
+
It gives a repository a version-controlled source of truth for how agents load
5
+
context, route work by role, handle approval gates, validate changes, record
6
+
decisions, and hand off structured context across tools.
7
+
8
+
Use this template when you want repeatable agent behavior across Codex, Claude,
9
+
Copilot, Cursor, OpenCode, Windsurf, or a generic CLI workflow. It is not an app
10
+
runtime or product framework; it is the operating layer around agent-assisted
11
+
software work.
12
+
13
+
## What This Repository Contains
14
+
15
+
- Root agent instructions through `AGENTS.md`
16
+
- Source-of-truth operating and routing docs in `docs/`
17
+
- Layered reusable rules in `rules/global/`, `rules/domain/`, and `project/`
18
+
- Reusable skills in `skills/*/SKILL.md`
19
+
- Tool-specific agent surfaces for Claude and GitHub Copilot
20
+
- Adapter harnesses for Claude Code, Copilot, Cursor, OpenCode, Windsurf, and generic CLI use
21
+
- Governance scripts for linting, budget reporting, trace review, context-pack generation, and eval scoring
22
+
- GitHub Actions workflows for markdown lint, rule governance, and trace review
23
+
- Evals and deterministic tooling fixtures for checking governance behavior
24
+
- Release metadata in `VERSION` and `CHANGELOG.md`
25
+
3
26
## Quick-start onboarding paths
4
27
5
28
Choose the path that fits your situation — all three lead to the same governance model.
@@ -59,15 +82,15 @@ The table below shows how each governance gate behaves across the three trust le
59
82
60
83
Legend: **STOP** = agent pauses and waits for human input. **Advisory** = agent logs the event and continues. Gate behavior is defined in `docs/operating-rules.md` → Trust level.
61
84
62
-
## Quick Start (3 steps)
85
+
## Adopter Quick Start
63
86
64
87
1. Copy this template into your repository (or create a repo from this template).
65
88
2. Edit the two source-of-truth docs first: `docs/operating-rules.md` and `docs/agent-playbook.md`. Update `AGENTS.md` after them as the root entrypoint.
66
-
3. Run your first task with the required workflow: discover -> triage -> plan (if needed) -> implement -> validate -> record decisions.
89
+
3. Run your first task with the required workflow: discover -> triage -> plan (if needed) -> implement -> validate -> record decisions according to `prompt-budget.yml` -> `decision_log.policy`.
67
90
68
91
For first entry into a new repository, use the profile-aware initialization path: at `minimal`, follow the manual scan path in `docs/rules-quickstart.md`; at `standard`/`full`, run `skills/on-project-start/SKILL.md` before implementation.
69
92
70
-
If you only do one thing on day one: keep `DECISIONS.md` updated so future agent runs can perform contradiction checks.
93
+
If you only do one thing on day one after adopting this template: switch `decision_log.policy` to `normal` and keep `DECISIONS.md` updated so future agent runs can perform contradiction checks.
71
94
72
95
## Mental model
73
96
@@ -141,7 +164,7 @@ flowchart LR
141
164
D --> E[Role Selection]
142
165
E --> F[skills/*/SKILL.md]
143
166
F --> G[Implementation + Validation Loop]
144
-
G --> H[DECISIONS.md Update]
167
+
G --> H[Decision Record<br/>per decision_log.policy]
145
168
H --> I[Future Contradiction Checks]
146
169
```
147
170
@@ -167,7 +190,7 @@ For staged simplification and automation steps, see `docs/rule-optimization-plan
167
190
4. Plan path: Small uses the simplified path; bounded Medium work may go directly to implementation; ambiguous, high-risk, or cross-module Medium/Large work uses the full planning path.
168
191
5. Implement safely: keep scope tight and follow repository patterns.
169
192
6. Validate: run targeted checks/tests, fix, and repeat until stable.
170
-
7. Record durable state: update `DECISIONS.md` when behavior or architecture choices are made.
193
+
7. Record durable state according to `prompt-budget.yml` -> `decision_log.policy`: adopted projects usually update `DECISIONS.md`; this template repo records task decisions in summaries, handoffs, or traces.
171
194
172
195
This flow is what makes the template useful in real teams: predictable output quality, lower drift, and faster onboarding.
173
196
@@ -192,13 +215,19 @@ If you maintain a fork, keep these phrases in your repository description and RE
192
215
- a machine-readable context-pack contract for multi-tool orchestration
193
216
- a canonical trace schema (`docs/schemas/trace.schema.yaml`) usable by any adapter
194
217
- an adapter-neutral evals framework (`evals/`) that verifies governance rules across tools
218
+
- harness adapters and shell-first governance scripts for local and CI validation
195
219
- reusable skills you can adapt into your own agent ecosystem
196
220
- repo-wide Copilot instructions
197
221
198
222
## Current asset inventory
199
223
224
+
- Version: 0.20.0 (`VERSION`)
200
225
- Claude subagents: 8 (`.claude/agents/*.md`)
201
226
- Reusable skills: 18 (`skills/*/SKILL.md`)
227
+
- Governance scripts: 14 (`scripts/*`)
228
+
- GitHub workflows: 3 (`.github/workflows/*.yml`)
229
+
- Adapter harnesses: 6 (`harness/adapters/*`)
230
+
- Example profiles and notes: 4 (`examples/*.md`)
202
231
- Source-of-truth docs: `docs/operating-rules.md`, `docs/agent-playbook.md` (`AGENTS.md` is the root entrypoint that should stay aligned with them)
203
232
204
233
## Example gallery
@@ -208,6 +237,7 @@ Use `examples/` for ready-to-adapt constraint profiles:
208
237
-`examples/high-security-mode.md`
209
238
-`examples/mvp-rapid-mode.md`
210
239
-`examples/legacy-maintenance.md`
240
+
-`examples/anti-patterns.md`
211
241
212
242
## Required vs optional files
213
243
@@ -234,6 +264,8 @@ Use `examples/` for ready-to-adapt constraint profiles:
234
264
-`docs/example-task-walkthrough.md` — reference for expected output formats
235
265
-`docs/external-practices-notes.md`
236
266
-`docs/adoption-guide.md`
267
+
-`harness/` — adapter hooks and wrapper scripts for tools that support or emulate governance hooks
268
+
-`evals/` — adapter-neutral behavior fixtures and scoring helpers
0 commit comments