@heihei0299/matt-skills 1.3.0 → 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/.agents/skills/ask-matt/PHASE-BOUNDARIES.md +55 -0
  2. package/.agents/skills/ask-matt/SKILL.md +37 -25
  3. package/.agents/skills/code-review/SKILL.md +28 -35
  4. package/.agents/skills/codebase-design/DEEPENING.md +4 -4
  5. package/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +10 -10
  6. package/.agents/skills/codebase-design/SKILL.md +13 -13
  7. package/.agents/skills/diagnosing-bugs/SKILL.md +34 -30
  8. package/.agents/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +3 -0
  9. package/.agents/skills/domain-modeling/ADR-FORMAT.md +11 -11
  10. package/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +3 -3
  11. package/.agents/skills/domain-modeling/SKILL.md +10 -10
  12. package/.agents/skills/grill-me/SKILL.md +1 -1
  13. package/.agents/skills/grill-with-docs/SKILL.md +1 -1
  14. package/.agents/skills/grilling/SKILL.md +20 -4
  15. package/.agents/skills/grilling/agents/openai.yaml +1 -1
  16. package/.agents/skills/handoff/SKILL.md +1 -1
  17. package/.agents/skills/improve-codebase-architecture/HTML-REPORT.md +19 -19
  18. package/.agents/skills/improve-codebase-architecture/SKILL.md +21 -21
  19. package/.agents/skills/prototype/LOGIC.md +30 -42
  20. package/.agents/skills/prototype/SKILL.md +7 -7
  21. package/.agents/skills/prototype/UI.md +23 -23
  22. package/.agents/skills/research/SKILL.md +1 -1
  23. package/.agents/skills/resolving-merge-conflicts/SKILL.md +1 -1
  24. package/.agents/skills/setup-matt-pocock-skills/SKILL.md +30 -30
  25. package/.agents/skills/setup-matt-pocock-skills/domain.md +4 -4
  26. package/.agents/skills/setup-matt-pocock-skills/issue-tracker-github.md +5 -5
  27. package/.agents/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +6 -6
  28. package/.agents/skills/setup-matt-pocock-skills/issue-tracker-local.md +3 -3
  29. package/.agents/skills/tdd/SKILL.md +9 -7
  30. package/.agents/skills/teach/GLOSSARY-FORMAT.md +3 -3
  31. package/.agents/skills/teach/LEARNING-RECORD-FORMAT.md +10 -10
  32. package/.agents/skills/teach/MISSION-FORMAT.md +4 -4
  33. package/.agents/skills/teach/RESOURCES-FORMAT.md +2 -2
  34. package/.agents/skills/teach/SKILL.md +4 -4
  35. package/.agents/skills/to-questionnaire/SKILL.md +54 -0
  36. package/.agents/skills/to-questionnaire/agents/openai.yaml +5 -0
  37. package/.agents/skills/to-spec/SKILL.md +4 -4
  38. package/.agents/skills/to-tickets/SKILL.md +16 -16
  39. package/.agents/skills/triage/AGENT-BRIEF.md +9 -9
  40. package/.agents/skills/triage/OUT-OF-SCOPE.md +15 -15
  41. package/.agents/skills/triage/SKILL.md +29 -29
  42. package/.agents/skills/wait-what/SKILL.md +7 -0
  43. package/.agents/skills/wait-what/agents/openai.yaml +5 -0
  44. package/.agents/skills/wayfinder/SKILL.md +37 -37
  45. package/.agents/skills/wizard/SKILL.md +44 -0
  46. package/.agents/skills/wizard/agents/openai.yaml +3 -0
  47. package/.agents/skills/wizard/template.sh +204 -0
  48. package/.agents/skills/writing-for-agents/SKILL-MECHANICS.md +22 -0
  49. package/.agents/skills/writing-for-agents/SKILL.md +81 -0
  50. package/.agents/skills/writing-for-agents/agents/openai.yaml +3 -0
  51. package/README.md +20 -16
  52. package/bin/cli.js +90 -58
  53. package/package.json +1 -1
  54. package/template/.opencode/CONTEXT.md +4 -0
  55. package/template/.opencode/commands/{writing-great-skills.md → writing-for-agents.md} +1 -1
  56. package/template/.opencode/docs/agents/skill-design.md +3 -3
  57. package/template/.pi/CONTEXT.md +55 -0
  58. package/template/.pi/docs/agents/runtime-discipline.md +3 -2
  59. package/template/.pi/docs/agents/skill-design.md +10 -5
  60. package/template/AGENTS.md +2 -2
  61. package/.agents/skills/writing-great-skills/GLOSSARY.md +0 -201
  62. package/.agents/skills/writing-great-skills/SKILL.md +0 -83
  63. package/.agents/skills/writing-great-skills/agents/openai.yaml +0 -5
@@ -1,37 +1,37 @@
1
1
  ---
2
2
  name: wayfinder
3
- description: Plan a huge chunk of work — more than one agent session can hold — as a shared map of decision tickets on your issue tracker, and resolve them one at a time until the way to the destination is clear.
3
+ description: Plan a huge chunk of work (more than one agent session can hold) as a shared map of decision tickets on your issue tracker, and resolve them one at a time until the way to the destination is clear.
4
4
  disable-model-invocation: true
5
5
  ---
6
6
 
7
- A loose idea has arrived — too big for one agent session, and wrapped in fog: the way from here to the **destination** isn't visible yet. Wayfinding is about finding that way, not charging at the destination. This skill charts the way as a **shared map** on the repo's issue tracker, then works its **decision tickets** — questions whose resolution is a decision, not slices of a build to execute — one at a time until the route is clear.
7
+ A loose idea has arrived, too big for one agent session, and wrapped in fog: the way from here to the **destination** isn't visible yet. Wayfinding is about finding that way, not charging at the destination. This skill charts the way as a **shared map** on the repo's issue tracker, then works its **decision tickets** (questions whose resolution is a decision, not slices of a build to execute) one at a time until the route is clear.
8
8
 
9
- The destination varies per effort, and naming it is the first act of charting — it shapes every ticket. It might be a spec to hand off and iterate on, a decision to lock before planning starts, or a change made in place like a data-structure migration. The map is domain-agnostic — engineering work, course content, whatever fits the shape.
9
+ The destination varies per effort, and naming it is the first act of charting: it shapes every ticket. It might be a spec to hand off and iterate on, a decision to lock before planning starts, or a change made in place like a data-structure migration. The map is domain-agnostic: engineering work, course content, whatever fits the shape.
10
10
 
11
11
  ## Plan, don't do
12
12
 
13
- Wayfinder is **planning** by default: each ticket resolves a decision, and the map is done when the way is clear — nothing left to decide before someone goes and does the thing. The pull to just do the work is usually the signal you've reached the edge of the map and it's time to hand off. An effort can override this in its **Notes** — carrying execution into the map itself — but absent that, produce decisions, not deliverables.
13
+ Wayfinder is **planning** by default: each ticket resolves a decision, and the map is done when the way is clear, with nothing left to decide before someone goes and does the thing. The pull to just do the work is usually the signal you've reached the edge of the map and it's time to hand off. An effort can override this in its **Notes**, carrying execution into the map itself, but absent that, produce decisions, not deliverables.
14
14
 
15
15
  ## Refer by name
16
16
 
17
- Every map and ticket is an issue, so it has a **name** — its title. In everything the human reads — narration, the map's Decisions-so-far — refer to it by that name, never by a bare id, number, or slug. A wall of `#42, #43, #44` is illegible; names read at a glance. The id and URL don't vanish — a name wraps its link — but they ride *inside* the name, never stand in for it.
17
+ Every map and ticket is an issue, so it has a **name**: its title. In everything the human reads (narration, the map's Decisions-so-far), refer to it by that name, never by a bare id, number, or slug. A wall of `#42, #43, #44` is illegible; names read at a glance. The id and URL don't vanish; a name wraps its link, but they ride _inside_ the name, never stand in for it.
18
18
 
19
19
  ## The Map
20
20
 
21
- The map is a single issue on this repo's issue tracker, labelled `wayfinder:map` — the canonical artifact. Its tickets are child issues of the map.
21
+ The map is a single issue on this repo's issue tracker, labelled `wayfinder:map`, the canonical artifact. Its tickets are child issues of the map.
22
22
 
23
- The map is an **index**, not a store. It lists the decisions made and points at the tickets that hold their detail; a decision lives in exactly one place — its ticket — so the map never restates it, only gists it and links.
23
+ The map is an **index**, not a store. It lists the decisions made and points at the tickets that hold their detail; a decision lives in exactly one place, its ticket, so the map never restates it, only gists it and links.
24
24
 
25
- **Where the map, its child tickets, blocking, and frontier queries physically live is tracker-specific.** The issue tracker should have been provided to you — run `/setup-matt-pocock-skills` if not. Consult the tracker doc's "Wayfinding operations" section for how _this_ repo expresses them. If no tracker has been provided, default to the local-markdown tracker.
25
+ **Where the map, its child tickets, blocking, and frontier queries physically live is tracker-specific.** The issue tracker should have been provided to you. If not, tell the user to run `/setup-matt-pocock-skills`. Consult the tracker doc's "Wayfinding operations" section for how _this_ repo expresses them. If no tracker has been provided, default to the local-markdown tracker.
26
26
 
27
27
  ### The map body
28
28
 
29
- The whole map at low resolution, loaded once per session. Open tickets are **not** listed — they are open child issues, found by query.
29
+ The whole map at low resolution, loaded once per session. Open tickets are **not** listed: they are open child issues, found by query.
30
30
 
31
31
  ```markdown
32
32
  ## Destination
33
33
 
34
- <what reaching the end of this map looks like — the spec, decision, or change this effort is finding its way to. One or two lines; every session orients to it before choosing a ticket.>
34
+ <what reaching the end of this map looks like: the spec, decision, or change this effort is finding its way to. One or two lines; every session orients to it before choosing a ticket.>
35
35
 
36
36
  ## Notes
37
37
 
@@ -39,9 +39,9 @@ The whole map at low resolution, loaded once per session. Open tickets are **not
39
39
 
40
40
  ## Decisions so far
41
41
 
42
- <!-- the index — one line per closed ticket: enough to judge relevance, then zoom the link for the detail the ticket holds -->
42
+ <!-- the index: one line per closed ticket, enough to judge relevance, then zoom the link for the detail the ticket holds -->
43
43
 
44
- - [<closed ticket title>](link) — <one-line gist of the answer>
44
+ - [<closed ticket title>](link): <one-line gist of the answer>
45
45
 
46
46
  ## Not yet specified
47
47
 
@@ -62,67 +62,67 @@ Each ticket is a **child issue** of the map; the tracker's issue id is its ident
62
62
  <the decision or investigation this ticket resolves>
63
63
  ```
64
64
 
65
- Each ticket carries a `wayfinder:<type>` label — one of `research`, `prototype`, `grilling`, `task` (see [Ticket Types](#ticket-types)).
65
+ Each ticket carries a `wayfinder:<type>` label, one of `research`, `prototype`, `grilling`, `task` (see [Ticket Types](#ticket-types)).
66
66
 
67
67
  A session **claims** a ticket by assigning it to the dev driving the map, **first**, before any work, so concurrent sessions skip it. That assignee _is_ the claim: an open, unassigned ticket is unclaimed.
68
68
 
69
- Blocking uses the tracker's **native** dependency relationship — essential because it renders the frontier _visually_ in the tracker's own UI, so the human sees what's takeable without opening the map. Only a tracker that lacks native blocking falls back to a body convention. A ticket is **unblocked** when every ticket blocking it is closed; the **frontier** is the open, unblocked, unclaimed children — the edge of the known.
69
+ Blocking uses the tracker's **native** dependency relationship: essential because it renders the frontier _visually_ in the tracker's own UI, so the human sees what's takeable without opening the map. Only a tracker that lacks native blocking falls back to a body convention. A ticket is **unblocked** when every ticket blocking it is closed; the **frontier** is the open, unblocked, unclaimed children, the edge of the known.
70
70
 
71
- The answer isn't part of the body — it's recorded on resolution (see [Work through the map](#work-through-the-map)). Assets created while resolving a ticket are linked from the issue, not pasted in.
71
+ The answer isn't part of the body; it's recorded on resolution (see [Work through the map](#work-through-the-map)). Assets created while resolving a ticket are linked from the issue, not pasted in.
72
72
 
73
73
  ## Ticket Types
74
74
 
75
- Every ticket is either **HITL** — human in the loop, worked *with* a human who speaks for themselves — or **AFK**, driven by the agent alone. A HITL ticket only resolves through that live exchange; the agent never stands in for the human's side of it (a grilling agent that answers its own questions has broken this).
75
+ Every ticket is either **HITL** (human in the loop, worked _with_ a human who speaks for themselves) or **AFK**, driven by the agent alone. A HITL ticket only resolves through that live exchange; the agent never stands in for the human's side of it (a grilling agent that answers its own questions has broken this).
76
76
 
77
- - **Research** (AFK): Reading documentation, third-party APIs, or local resources like knowledge bases to surface a fact a decision waits on. Resolved by a `/research` **subagent**. Use when knowledge outside the current working directory is required.
78
- - **Prototype** (HITL): Raise the fidelity of the discussion by making a cheap, rough, concrete artifact to react to — an outline, a rough take, a stub, or UI/logic code via the /prototype skill. Links the prototype as an asset. Use when "how should it look" or "how should it behave" is the key question.
79
- - **Grilling** (HITL): Conversation via the /grilling and /domain-modeling skills, one question at a time. The default case.
80
- - **Task** (HITL or AFK): Manual work that must happen before a *decision* can be made — nothing to decide, prototype, or research, but the discussion is blocked until it's done. Signing up for a service so its API can be judged, provisioning access, moving data so its shape can be seen. This is the one type that *does* rather than decides — and it earns its place by unblocking a decision, not by delivering the destination. The agent drives it alone where it can (AFK); otherwise it hands the human a precise checklist (HITL). Resolved when the work is done; the answer records what was done and any resulting facts (credentials location, new URLs, row counts) later tickets depend on.
77
+ - **Research** (AFK): Reading documentation, third-party APIs, or local resources like knowledge bases to surface a fact a decision waits on. Resolved by a subagent that calls the Skill tool with "research". Use when knowledge outside the current working directory is required.
78
+ - **Prototype** (HITL): Raise the fidelity of the discussion by making a cheap, rough, concrete artifact to react to (an outline, a rough take, a stub, or UI/logic code) by calling the Skill tool with "prototype". Links the prototype as an asset. Use when "how should it look" or "how should it behave" is the key question.
79
+ - **Grilling** (HITL): Conversation. The default case. Always call the Skill tool twice, for "grilling" and "domain-modeling".
80
+ - **Task** (HITL or AFK): Manual work that must happen before a _decision_ can be made: nothing to decide, prototype, or research, but the discussion is blocked until it's done. Signing up for a service so its API can be judged, provisioning access, moving data so its shape can be seen. This is the one type that _does_ rather than decides, and it earns its place by unblocking a decision, not by delivering the destination. The agent drives it alone where it can (AFK); otherwise it hands the human a precise checklist (HITL). Resolved when the work is done; the answer records what was done and any resulting facts (credentials location, new URLs, row counts) later tickets depend on.
81
81
 
82
82
  ## Fog of war
83
83
 
84
- The map is _deliberately_ incomplete: don't chart what you can't yet see. Beyond the live tickets lies the **fog of war** — the dim view of decisions and investigations you can tell are coming but can't yet pin down, because they hang on questions still open. Resolving a ticket clears the fog ahead of it, graduating whatever's now specifiable into fresh tickets — one at a time, until the way to the destination is clear and no tickets remain.
84
+ The map is _deliberately_ incomplete: don't chart what you can't yet see. Beyond the live tickets lies the **fog of war**: the dim view of decisions and investigations you can tell are coming but can't yet pin down, because they hang on questions still open. Resolving a ticket clears the fog ahead of it, graduating whatever's now specifiable into fresh tickets, one at a time, until the way to the destination is clear and no tickets remain.
85
85
 
86
- The map's **Not yet specified** section is where that dim view is written down: the suspected question, the area to revisit later. It's the undiscovered frontier _toward_ the destination — everything here is in scope, just not sharp enough to ticket. Write as loosely or as fully as the view allows; it doubles as a signpost for collaborators reading where the effort is headed.
86
+ The map's **Not yet specified** section is where that dim view is written down: the suspected question, the area to revisit later. It's the undiscovered frontier _toward_ the destination: everything here is in scope, just not sharp enough to ticket. Write as loosely or as fully as the view allows; it doubles as a signpost for collaborators reading where the effort is headed.
87
87
 
88
- **Fog or ticket?** The test is whether you can state the question precisely now — _not_ whether you can answer it now.
88
+ **Fog or ticket?** The test is whether you can state the question precisely now, _not_ whether you can answer it now.
89
89
 
90
- - **Ticket when** the question is already sharp — even if it's blocked and you can't act on it yet.
90
+ - **Ticket when** the question is already sharp, even if it's blocked and you can't act on it yet.
91
91
  - **Not yet specified when** you can't yet phrase it that sharply. Don't pre-slice the fog into ticket-sized pieces: it's coarser than a ticket, and one patch may graduate into several tickets, or none, once the frontier reaches it.
92
92
 
93
93
  **Not yet specified** excludes what's already decided (Decisions so far), what's already a live ticket, and what's out of scope (the next section).
94
94
 
95
95
  ## Out of scope
96
96
 
97
- Fog only ever gathers _toward_ the destination. The destination fixes the scope, so work beyond it is **out of scope** — it isn't fog, and it doesn't belong in **Not yet specified**. It gets its own **Out of scope** section on the map: work you've consciously ruled out of _this_ effort. Scope, not sharpness, lands it here.
97
+ Fog only ever gathers _toward_ the destination. The destination fixes the scope, so work beyond it is **out of scope**: it isn't fog, and it doesn't belong in **Not yet specified**. It gets its own **Out of scope** section on the map: work you've consciously ruled out of _this_ effort. Scope, not sharpness, lands it here.
98
98
 
99
- Out-of-scope work never graduates — the frontier stops at the destination — so it returns only if the destination is redrawn, and then as a fresh effort, not a resumption.
99
+ Out-of-scope work never graduates (the frontier stops at the destination), so it returns only if the destination is redrawn, and then as a fresh effort, not a resumption.
100
100
 
101
- Ruling something out of scope is a scoping act, not a step on the route. When a ticket that already exists turns out to sit past the destination — mis-scoped in while charting, or exposed by a resolution — **close it** (a closed ticket is unambiguously off the frontier) and leave one line in the **Out of scope** section: the gist plus why it's out of scope, linking the closed ticket. It stays out of **Decisions so far**, which records the route actually walked — a scope boundary isn't a step on it.
101
+ Ruling something out of scope is a scoping act, not a step on the route. When a ticket that already exists turns out to sit past the destination (mis-scoped in while charting, or exposed by a resolution), **close it** (a closed ticket is unambiguously off the frontier) and leave one line in the **Out of scope** section: the gist plus why it's out of scope, linking the closed ticket. It stays out of **Decisions so far**, which records the route actually walked; a scope boundary isn't a step on it.
102
102
 
103
103
  ## Invocation
104
104
 
105
- Two modes. Either way, **never resolve more than one ticket per session** — with the exception of research tickets.
105
+ Two modes. Either way, **never resolve more than one ticket per session**, with the exception of research tickets.
106
106
 
107
107
  ### Chart the map
108
108
 
109
109
  User invokes with a loose idea.
110
110
 
111
- 1. **Name the destination.** Run a `/grilling` and `/domain-modeling` session to pin down what this map is finding its way to — the spec, decision, or change. The destination fixes the scope, so it's settled first.
112
- 2. **Map the frontier.** Grill again, **breadth-first** this time: fan out across the whole space rather than deep on any one thread, surfacing the open decisions and the first steps takeable now. **If this surfaces no fog** — the way to the destination is already clear, the whole journey small enough for one session — you don't need a map. Stop and ask the user how they'd like to proceed.
111
+ 1. **Name the destination.** Call the Skill tool twice, for "grilling" and "domain-modeling", to pin down what this map is finding its way to: the spec, decision, or change. The destination fixes the scope, so it's settled first.
112
+ 2. **Map the frontier.** Grill again, **breadth-first** this time: fan out across the whole space rather than deep on any one thread, surfacing the open decisions and the first steps takeable now. **If this surfaces no fog** (the way to the destination is already clear, the whole journey small enough for one session), you don't need a map. Stop and ask the user how they'd like to proceed.
113
113
  3. **Create the map** (label `wayfinder:map`): Destination and Notes filled in, Decisions-so-far empty, the fog sketched into **Not yet specified**.
114
- 4. **Create the tickets you can specify now** as child issues of the map — then wire blocking edges in a **second pass** (issues need ids before they can reference each other). Wiring sorts them into the frontier and the blocked; everything you can't yet specify stays in the fog — the **Not yet specified** section.
115
- 5. **Fire the research subagents.** For each `research` ticket you just created, spin up a `/research` subagent to resolve it in parallel, capturing its findings on a throwaway `research/<name>` branch with a context pointer from the ticket.
116
- 6. Stop — charting is one session's work; it hand-resolves nothing.
114
+ 4. **Create the tickets you can specify now** as child issues of the map, then wire blocking edges in a **second pass** (issues need ids before they can reference each other). Wiring sorts them into the frontier and the blocked; everything you can't yet specify stays in the fog: the **Not yet specified** section.
115
+ 5. **Fire the research subagents.** For each `research` ticket you just created, spin up a subagent that calls the Skill tool with "research" to resolve it in parallel, capturing its findings on a throwaway `research/<name>` branch with a context pointer from the ticket.
116
+ 6. Stop: charting is one session's work; it hand-resolves nothing.
117
117
 
118
118
  ### Work through the map
119
119
 
120
- User invokes with a map (URL or number). A ticket is **optional** — without one, you pick the next decision, not the user.
120
+ User invokes with a map (URL or number). A ticket is **optional**: without one, you pick the next decision, not the user.
121
121
 
122
- 1. Load the **map** — the low-res view, not every ticket body.
122
+ 1. Load the **map**: the low-res view, not every ticket body.
123
123
  2. Choose the ticket. If the user named one, use it. Otherwise take the first frontier ticket in order. **Claim it**: assign it to yourself before any work.
124
- 3. Resolve it — **zoom as needed**: fetch the full body of any related or closed ticket on demand; invoke the skills the `## Notes` block names. If in doubt, use `/grilling` and `/domain-modeling`.
124
+ 3. Resolve it. **Zoom as needed**: fetch the full body of any related or closed ticket on demand; call the Skill tool for whichever skills the `## Notes` block names. If in doubt, call the Skill tool twice, for "grilling" and "domain-modeling".
125
125
  4. Record the resolution: post the answer as a **resolution comment**, **close** the issue, and **append a context pointer** to the map's Decisions-so-far.
126
- 5. Add newly-surfaced tickets (create-then-wire); graduate any fog the answer has made specifiable, clearing each graduated patch from **Not yet specified** so it lives only as its new ticket. If the answer reveals a ticket — this one or another — sits beyond the destination, **rule it out of scope** rather than resolving it on the route. If the decision invalidates other parts of the map, update or delete those tickets.
126
+ 5. Add newly-surfaced tickets (create-then-wire); graduate any fog the answer has made specifiable, clearing each graduated patch from **Not yet specified** so it lives only as its new ticket. If the answer reveals that a ticket (this one or another) sits beyond the destination, **rule it out of scope** rather than resolving it on the route. If the decision invalidates other parts of the map, update or delete those tickets.
127
127
 
128
128
  The user may run unblocked tickets in parallel, so expect other sessions to be editing the tracker concurrently.
@@ -0,0 +1,44 @@
1
+ ---
2
+ name: wizard
3
+ description: Generate an interactive bash wizard that walks a human through steps only they can perform. Use when provisioning infrastructure, setting up credentials or CI secrets, walking an unfamiliar third-party dashboard, or running a one-off migration or cutover. Don't invoke this for steps the agent can perform itself.
4
+ ---
5
+
6
+ # Wizard
7
+
8
+ A **wizard** is a bash script that walks a human, step by step, through a manual procedure that's tedious to do by hand and tedious to re-explain to an AI every time. It opens each URL, says exactly what to click and copy, captures the values, writes them where they belong (`.env`, GitHub secrets), confirms at every stage, and shows how many stages are left. It might configure third-party services, run a one-off migration, or move the project from one state to another.
9
+
10
+ The delightful UX is already solved by [template.sh](template.sh): stage-by-stage progress, confirmation gates, cross-platform URL opening (including WSL), hidden secret entry, idempotent `.env` upserts, `gh secret`/`gh variable` writes, and a closing summary. **Your job is only to scope the procedure and author its stages.** The library above the `STAGES` marker is identical in every wizard; that consistency is the point: never hand-edit it.
11
+
12
+ A wizard is ephemeral by default: built for one run, saved to a scratch or `scripts/` path, deleted when the job's done. Commit it only when the user wants a repeatable setup path that should live in the repo.
13
+
14
+ ## Process
15
+
16
+ ### 1. Scope the procedure
17
+
18
+ Work out every manual step the human must take and every value that gets captured along the way. Read the repo first, don't ask cold:
19
+
20
+ - For setup: `.env`, `.env.example`, `.env.*`, `README`, `docker-compose*`, framework config, and `.github/workflows/*` (every `secrets.*` / `vars.*` reference is a value the wizard must produce).
21
+ - For a migration or transition: the current state, the target state, and the irreversible actions between them.
22
+
23
+ Then show the user the ordered list of stages and the values each produces, and confirm: they may add, drop, or reorder.
24
+
25
+ **Done when:** every stage is named in order, and for each captured value you know (a) where the human gets it, (b) where it's written (`.env`, a GitHub secret, both, or nowhere; some stages are pure actions), and (c) whether it's secret (hidden entry) or public.
26
+
27
+ ### 2. Map each stage's journey
28
+
29
+ For each stage, write the precise path a human follows: which URL to open, what to do there, where a value is shown, which variable it fills: e.g. "Dashboard → Developers → API keys → Reveal test key → copy". Where you don't actually know the current UI or the exact command, say so and ask the user or check the docs: never invent steps that may not exist.
30
+
31
+ **Done when:** every stage traces to concrete instructions a stranger could follow.
32
+
33
+ ### 3. Author the wizard
34
+
35
+ Copy `template.sh` to the target path. Replace the example stage with one `stage` per step, in dependency order. Use the library helpers: `stage`, `say`/`step`, `open_url`, `ask`/`ask_secret`, `write_env`, `set_secret`/`set_var`, `pause`/`confirm`. Set `TOTAL_STAGES` to the number of stages you wrote.
36
+
37
+ Hold the bar the template sets: open the URL before asking for its value, use `ask_secret` for anything secret, `write_env` every persisted value, `set_secret` only the values CI actually needs, and `confirm` before any irreversible action. Each `stage` clears the screen so only the current step is visible: keep a stage to one focused task so nothing the human needs scrolls away. Don't touch the library above the marker.
38
+
39
+ ### 4. Verify and hand off
40
+
41
+ - `bash -n <script>`; run `shellcheck` if available.
42
+ - `chmod +x <script>`.
43
+ - Don't run it end-to-end yourself: it opens browsers and blocks on human input. Trace it statically instead: every value from step 1 is captured and lands where step 1 said, and every `set_secret` name exactly matches a `secrets.*` reference in CI.
44
+ - Tell the user how to run it. If it's a repeatable setup path, commit it and link it from the README so the next person runs the script instead of asking an AI.
@@ -0,0 +1,3 @@
1
+ interface:
2
+ display_name: "Wizard"
3
+ short_description: "Generate an interactive setup wizard"
@@ -0,0 +1,204 @@
1
+ #!/usr/bin/env bash
2
+ #
3
+ # A wizard walks a human through a manual procedure, step by step.
4
+ # Generated by the /wizard skill.
5
+ #
6
+ # Everything above the "STAGES" marker is the wizard library: do not hand-edit
7
+ # it. Author the per-step stages below the marker.
8
+
9
+ set -euo pipefail
10
+
11
+ # ──────────────────────────────────────────────────────────────────────────
12
+ # Wizard library: delightful, consistent UX, identical across every wizard.
13
+ # ──────────────────────────────────────────────────────────────────────────
14
+
15
+ if [[ -t 1 ]] && command -v tput >/dev/null 2>&1 && [[ "$(tput colors 2>/dev/null || echo 0)" -ge 8 ]]; then
16
+ BOLD=$(tput bold); DIM=$(tput dim); RESET=$(tput sgr0)
17
+ BLUE=$(tput setaf 4); GREEN=$(tput setaf 2); YELLOW=$(tput setaf 3); RED=$(tput setaf 1)
18
+ else
19
+ BOLD=""; DIM=""; RESET=""; BLUE=""; GREEN=""; YELLOW=""; RED=""
20
+ fi
21
+
22
+ # Author sets this at the top of the stages section.
23
+ TOTAL_STAGES=0
24
+
25
+ _STAGE_INDEX=0
26
+ ENV_FILE="${ENV_FILE:-.env}"
27
+ WRITTEN_ENV=() # KEYs written to ENV_FILE this run
28
+ WRITTEN_SECRET=() # secret NAMEs set this run
29
+ SKIPPED=() # things we couldn't do (e.g. gh missing)
30
+
31
+ # _clear wipes the terminal so only the current step is on screen. No-op when
32
+ # output isn't a terminal, so piped logs stay readable.
33
+ _clear() {
34
+ [[ -t 1 ]] || return 0
35
+ if command -v tput >/dev/null 2>&1; then tput clear; else printf '\033[2J\033[3J\033[H'; fi
36
+ }
37
+
38
+ # banner "Title" shows the opening frame: what this wizard does.
39
+ banner() {
40
+ _clear
41
+ printf '\n%s%s %s%s\n' "$BOLD" "$BLUE" "$1" "$RESET"
42
+ printf '%s %s stages%s\n\n' "$DIM" "$TOTAL_STAGES" "$RESET"
43
+ printf '%s You drive the browser; this wizard tells you exactly what to do and\n' "$DIM"
44
+ printf ' captures the values you copy back. Stop any time with Ctrl-C and re-run\n'
45
+ printf ' later, since it remembers values already saved.%s\n' "$RESET"
46
+ pause "Ready to start?"
47
+ }
48
+
49
+ # stage "Name" clears the screen, then announces a stage and shows progress.
50
+ # Clearing keeps only the current step on screen.
51
+ stage() {
52
+ _clear
53
+ _STAGE_INDEX=$((_STAGE_INDEX + 1))
54
+ printf '\n%s%s▸ Stage %s/%s · %s%s\n' \
55
+ "$BOLD" "$BLUE" "$_STAGE_INDEX" "$TOTAL_STAGES" "$1" "$RESET"
56
+ }
57
+
58
+ # say "..." prints a plain instruction line.
59
+ say() { printf ' %s\n' "$1"; }
60
+ # step "..." is a numbered-feeling action the human takes in the browser.
61
+ step() { printf ' %s•%s %s\n' "$BLUE" "$RESET" "$1"; }
62
+ note() { printf ' %s%s%s\n' "$DIM" "$1" "$RESET"; }
63
+ warn() { printf ' %s⚠ %s%s\n' "$YELLOW" "$1" "$RESET"; }
64
+
65
+ # open_url URL opens it in the human's browser, cross-platform incl. WSL.
66
+ open_url() {
67
+ local url="$1"
68
+ printf ' %s↗ opening%s %s\n' "$GREEN" "$RESET" "$url"
69
+ { if command -v wslview >/dev/null 2>&1; then wslview "$url"
70
+ elif command -v explorer.exe >/dev/null 2>&1; then explorer.exe "$url"
71
+ elif command -v xdg-open >/dev/null 2>&1; then xdg-open "$url"
72
+ elif command -v open >/dev/null 2>&1; then open "$url"
73
+ else warn "couldn't open a browser; visit it manually: $url"; fi
74
+ } >/dev/null 2>&1 || warn "couldn't open a browser, so visit it manually: $url"
75
+ }
76
+
77
+ # pause "msg" waits for the human to confirm they've done the manual part.
78
+ pause() {
79
+ printf ' %s%s%s ' "$DIM" "${1:-Press Enter to continue}" "$RESET"
80
+ read -r _ || true
81
+ }
82
+
83
+ # confirm "question" is a y/N gate; returns success on yes.
84
+ confirm() {
85
+ local reply=""
86
+ printf ' %s? %s [y/N] ' "$YELLOW" "$1"
87
+ read -r reply || true
88
+ [[ "$reply" =~ ^[Yy] ]]
89
+ }
90
+
91
+ # _existing KEY: current value of KEY in ENV_FILE, if any.
92
+ _existing() {
93
+ [[ -f "$ENV_FILE" ]] || return 1
94
+ local line; line=$(grep -E "^${1}=" "$ENV_FILE" | tail -n1) || return 1
95
+ printf '%s' "${line#*=}"
96
+ }
97
+
98
+ # ask KEY "Prompt" reads a value into $KEY. Offers the existing .env value as
99
+ # a default on re-runs (Enter keeps it). Visible input (non-secret).
100
+ ask() {
101
+ local key="$1" prompt="$2" current input
102
+ current=$(_existing "$key" || true)
103
+ if [[ -n "$current" ]]; then
104
+ printf ' %s%s%s %s[Enter keeps current]%s ' "$BOLD" "$prompt" "$RESET" "$DIM" "$RESET"
105
+ else
106
+ printf ' %s%s%s ' "$BOLD" "$prompt" "$RESET"
107
+ fi
108
+ read -r input || true
109
+ [[ -z "$input" && -n "$current" ]] && input="$current"
110
+ printf -v "$key" '%s' "$input"
111
+ }
112
+
113
+ # ask_secret KEY "Prompt" is like ask, but input is hidden.
114
+ ask_secret() {
115
+ local key="$1" prompt="$2" current input
116
+ current=$(_existing "$key" || true)
117
+ if [[ -n "$current" ]]; then
118
+ printf ' %s%s%s %s[Enter keeps current]%s ' "$BOLD" "$prompt" "$RESET" "$DIM" "$RESET"
119
+ else
120
+ printf ' %s%s%s ' "$BOLD" "$prompt" "$RESET"
121
+ fi
122
+ read -rs input || true
123
+ printf '\n'
124
+ [[ -z "$input" && -n "$current" ]] && input="$current"
125
+ printf -v "$key" '%s' "$input"
126
+ }
127
+
128
+ # write_env KEY VALUE upserts KEY=VALUE into ENV_FILE (creates it; replaces
129
+ # any existing line). Idempotent.
130
+ write_env() {
131
+ local key="$1" value="$2" tmp
132
+ touch "$ENV_FILE"
133
+ tmp=$(mktemp)
134
+ grep -vE "^${key}=" "$ENV_FILE" > "$tmp" || true
135
+ printf '%s=%s\n' "$key" "$value" >> "$tmp"
136
+ mv "$tmp" "$ENV_FILE"
137
+ WRITTEN_ENV+=("$key")
138
+ printf ' %s✓ wrote%s %s → %s\n' "$GREEN" "$RESET" "$key" "$ENV_FILE"
139
+ }
140
+
141
+ # set_secret NAME VALUE sets a GitHub Actions repo secret via gh. Falls back
142
+ # to a warning (and records it) if gh is unavailable or unauthenticated.
143
+ set_secret() {
144
+ local name="$1" value="$2"
145
+ if command -v gh >/dev/null 2>&1 && gh auth status >/dev/null 2>&1; then
146
+ if printf '%s' "$value" | gh secret set "$name" >/dev/null 2>&1; then
147
+ WRITTEN_SECRET+=("$name")
148
+ printf ' %s✓ set%s GitHub secret %s\n' "$GREEN" "$RESET" "$name"
149
+ return
150
+ fi
151
+ fi
152
+ SKIPPED+=("GitHub secret $name (set it manually: gh secret set $name)")
153
+ warn "skipped GitHub secret $name: gh not ready; set it later"
154
+ }
155
+
156
+ # set_var NAME VALUE sets a GitHub Actions repo variable (non-secret).
157
+ set_var() {
158
+ local name="$1" value="$2"
159
+ if command -v gh >/dev/null 2>&1 && gh auth status >/dev/null 2>&1; then
160
+ if gh variable set "$name" --body "$value" >/dev/null 2>&1; then
161
+ printf ' %s✓ set%s GitHub variable %s\n' "$GREEN" "$RESET" "$name"
162
+ return
163
+ fi
164
+ fi
165
+ SKIPPED+=("GitHub variable $name")
166
+ warn "skipped GitHub variable $name, gh not ready; set it later"
167
+ }
168
+
169
+ # finish clears, then shows a closing summary of everything configured.
170
+ finish() {
171
+ _clear
172
+ printf '\n%s%s ✓ Setup complete%s\n' "$BOLD" "$GREEN" "$RESET"
173
+ (( ${#WRITTEN_ENV[@]} )) && note "wrote ${#WRITTEN_ENV[@]} value(s) to $ENV_FILE: ${WRITTEN_ENV[*]}"
174
+ (( ${#WRITTEN_SECRET[@]} )) && note "set ${#WRITTEN_SECRET[@]} GitHub secret(s): ${WRITTEN_SECRET[*]}"
175
+ if (( ${#SKIPPED[@]} )); then
176
+ printf '\n'; warn "still to do by hand:"
177
+ for s in "${SKIPPED[@]}"; do note " - $s"; done
178
+ fi
179
+ printf '\n'
180
+ }
181
+
182
+ # ──────────────────────────────────────────────────────────────────────────
183
+ # STAGES: author this section. One stage() per step the human takes.
184
+ # Replace the example below. Set TOTAL_STAGES to match the stages you write.
185
+ # ──────────────────────────────────────────────────────────────────────────
186
+
187
+ TOTAL_STAGES=1
188
+
189
+ banner "Stripe setup"
190
+
191
+ # ── Example stage: replace with your real steps ───────────────────────────
192
+ stage "Stripe: API keys"
193
+ say "We'll grab your Stripe test keys and store them for local dev + CI."
194
+ open_url "https://dashboard.stripe.com/test/apikeys"
195
+ step "On the API keys page, copy the Publishable key (starts pk_test_)."
196
+ ask STRIPE_PUBLISHABLE_KEY "Paste the publishable key:"
197
+ step "Click 'Reveal test key' on the Secret key row, then copy it."
198
+ ask_secret STRIPE_SECRET_KEY "Paste the secret key:"
199
+ write_env STRIPE_PUBLISHABLE_KEY "$STRIPE_PUBLISHABLE_KEY"
200
+ write_env STRIPE_SECRET_KEY "$STRIPE_SECRET_KEY"
201
+ set_secret STRIPE_SECRET_KEY "$STRIPE_SECRET_KEY" # CI needs this one
202
+ # ──────────────────────────────────────────────────────────────────────────
203
+
204
+ finish
@@ -0,0 +1,22 @@
1
+ # Skill mechanics
2
+
3
+ The skill-specific branch of [`writing-for-agents`](SKILL.md): what changes when the document is a skill (frontmatter, the invocation choice, and router skills). Everything else about writing it is the universal reference in `SKILL.md`.
4
+
5
+ ## Invocation
6
+
7
+ Two choices, trading the two loads:
8
+
9
+ - A **model-invoked** skill keeps a `description`, so the agent can fire it autonomously, and other skills can reach it. You can still type its name: model-invocation always _includes_ user reach; a description only ever adds agent discovery, never removes the human's. The description is the skill's top-level context pointer, forced to stay loaded at all times: permanent context load in exchange for discoverability. A model-invoked skill whose content is all reference is also one home for shared reference: another skill can invoke it, so reference needed by several skills lives in one place. Mechanics: omit `disable-model-invocation`, and write a model-facing description carrying the trigger branches (the pointer-writing rules in `SKILL.md` apply in full).
10
+ - A **user-invoked** skill strips the description from the agent's reach: only the human typing its name can invoke it, and no other skill can. Zero context load, but it spends cognitive load: you are the index that must remember it exists. Mechanics: set `disable-model-invocation: true`; the `description` becomes human-facing: a one-line summary, trigger lists stripped.
11
+
12
+ Pick model-invocation only when the agent must reach the skill on its own, or another skill must. If it only ever fires by hand, make it user-invoked and pay no context load.
13
+
14
+ Shared reference that two user-invoked skills both need can live in neither: with no descriptions, neither can fire the other. Push it to a plain file outside the skill system: external reference any skill can point at.
15
+
16
+ ## Splitting by invocation
17
+
18
+ The invocation cut of splitting (the sequence cut lives in `SKILL.md`): split off a model-invoked skill when you have a distinct leading word that should trigger it on its own (a trigger word you actually use in your prompts), or another skill must reach it. You pay context load for the new always-loaded description, so that independent reach has to be worth it.
19
+
20
+ ## Router skills
21
+
22
+ When user-invoked skills multiply past what you can remember, that piled-up cognitive load is cured by a **router skill**: one user-invoked skill that names the others and when to reach for each, so the human has one skill to remember instead of many. It can only hint, never fire them: user-invoked skills have no description, so nothing but the human can reach them.
@@ -0,0 +1,81 @@
1
+ ---
2
+ name: writing-for-agents
3
+ description: Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.
4
+ ---
5
+
6
+ Reference for writing any document an agent consumes: a skill, an `AGENTS.md` / `CLAUDE.md`, a doc reached by a pointer. The packaging differs; the writing does not: the same levers make each one predictable, since the agent takes the same _process_ every run rather than producing the same output.
7
+
8
+ When the document you're writing is a skill, read [`SKILL-MECHANICS.md`](SKILL-MECHANICS.md) for frontmatter, invocation choice, and router skills.
9
+
10
+ ## Context pointers
11
+
12
+ A **context pointer** is a reference held in the agent's context that names some out-of-context material and encodes the condition for reaching it. A skill's description is one; a line in `AGENTS.md` naming a doc is the same object. The pointer's _wording_, not its target, decides when the agent reaches the material, and how reliably. A must-have target behind a weakly worded pointer is a variance bug: sharpen the wording first, and inline the material only if sharpening fails.
13
+
14
+ A pointer does two jobs: state what the material is, and list the **branches** that should trigger reaching it (a branch is a distinct case the document handles, so different runs take different paths through it). Every word of an always-loaded pointer costs on every turn, so it earns even harder pruning than the body:
15
+
16
+ - **Front-load the leading word**: the pointer is where it does its triggering work.
17
+ - **One trigger per branch.** Synonyms that rename a single branch are one branch written twice; collapse them and keep only genuinely distinct branches.
18
+ - **Cut identity the body already carries.**
19
+
20
+ ## The two loads
21
+
22
+ Every document and pointer you add spends one of two budgets:
23
+
24
+ - **Context load** is the cost of always-loaded material on the agent's window: an `AGENTS.md` line, a skill description, anything sitting in context every turn, spending tokens and attention whether or not it fires.
25
+ - **Cognitive load** is the cost on the human: which documents exist and when to reach for each. The human is the index. Not a cost to minimise: it is the price of human agency; spend it where human judgement matters, remove it where it does not.
26
+
27
+ Material reached only through a pointer escapes context load at the price of the pointer's own line; material with no pointer at all rides entirely on cognitive load.
28
+
29
+ ## Information hierarchy
30
+
31
+ A document is built from two content types: **steps** (the ordered actions the agent performs) and **reference** (definitions, rules, facts consulted on demand). The two mix freely: all steps (a recipe), all reference (a review's rules, this skill), or both. The core decision is where each piece sits on the **information hierarchy**, a ladder ranked by how immediately the agent needs the material:
32
+
33
+ 1. **In-file step** is the primary tier: what the agent does, in order.
34
+ 2. **In-file reference** is consulted on demand. Often a legitimately flat peer-set (every rule of a review on one rung), which is a fine arrangement, not a smell.
35
+ 3. **Disclosed reference** is pushed out into a separate file, reached by a context pointer, loaded only when the pointer fires. Spans a sibling file in the same folder through fully external reference that lives anywhere and any document can point at.
36
+
37
+ Push too little down and the top bloats; push too much and you hide material the agent actually needs. That tension is the whole decision.
38
+
39
+ **Progressive disclosure** is the move down the ladder (out of the main file and behind a pointer) so the top stays legible. Not primarily a token optimisation: it is how the hierarchy is protected. Branching is the cleanest disclosure test: inline what every branch needs, and push behind a pointer what only some branches reach. When a document has steps, in-file reference that should be disclosed buries them and turns attending to them into a coin-flip: a variance lever, not just a legibility one.
40
+
41
+ **Co-location** is the within-file companion: where the ladder decides _how far down_ a piece sits, co-location decides _what sits beside it_ once there. Keep a concept's definition, rules, and caveats under one heading rather than scattered, so reading one part brings its neighbours with it. The test: the document should read like documentation written for the agent. Grouped material reads that way; scattered material does not. (Distinct from duplication: that repeats one meaning in two places; scattering fragments one meaning across many.)
42
+
43
+ **Sprawl** is the failure mode here: a document simply too long, even when every line is live and unique. Attention thins across the excess, and every extra line is one more to keep relevant. The cure is the ladder: disclose reference behind pointers, and split by branch or sequence so each path carries only what it needs.
44
+
45
+ ## Steps and completion criteria
46
+
47
+ Every step ends on a **completion criterion**, the condition that tells the agent the work is done. Two properties make it a lever:
48
+
49
+ - **Clarity**: can the agent tell done from not-done? A vague bound ("understanding reached") invites **premature completion**: ending the step before it is genuinely done, attention slipping to _being done_. The visible steps still ahead (the **post-completion steps**) supply the pull; the criterion's clarity is the resistance. Defend in order: **sharpen the bound first** (local and cheap); only if it is irreducibly fuzzy _and_ you observe the rush, hide the later steps by splitting the sequence. Hiding only works across a real context boundary (a hand-off or a subagent dispatch; an inline call leaves the later steps in context and clears nothing).
50
+ - **Demand**: how much it requires. "Every modified model accounted for" forces thorough work where "produce a change list" does not. Demand drives **legwork** (the digging the agent does within the work, latent in the wording rather than written as its own step), and it is not step-bound: "every rule applied" binds a body of flat reference just as "every step done" binds a sequence, which is how an all-reference document still carries an exhaustiveness bar.
51
+
52
+ The strongest criteria are both checkable and exhaustive.
53
+
54
+ ## When to split
55
+
56
+ Splitting one document into two spends one of the two loads, so split only when the cut earns it:
57
+
58
+ - **By sequence**: split a run of steps where the post-completion steps tempt the agent to rush the one in front of it. Keeping them out of view drives more legwork on the current task. Beware the reverse: merging sequences exposes each step's later steps to what follows, inviting premature completion.
59
+ - **By invocation**, skill-specific: see [`SKILL-MECHANICS.md`](SKILL-MECHANICS.md).
60
+
61
+ ## Leading words
62
+
63
+ A **leading word** is a compact concept already living in the model's pretraining that the agent thinks with while running the document (_lesson_, _fog of war_, _tracer bullets_). Repeated as a token, never as a sentence, it accumulates a distributed definition and anchors a whole region of behaviour in the fewest tokens, by recruiting priors the model already holds. Coining your own works if you define it clearly, but a made-up word recruits no priors: you pay in definition tokens what a pretrained word gives free; reach for an existing word first.
64
+
65
+ It anchors twice. In the body, _execution_: the agent reaches for the same behaviour every time the word appears, and inside flat reference it focuses attention on a class of thing to look for. In a pointer, _invocation_: when the same word lives in your prompts, your docs, and your codebase, the agent links that shared language to the material and reaches it more reliably.
66
+
67
+ Hunt for opportunities to refactor with leading words. A triad spelled out at three sites, a pointer spending a sentence to gesture at one idea. Each is a passage begging to collapse into a single token:
68
+
69
+ - "fast, deterministic, low-overhead" → _tight_ (a _tight_ loop).
70
+ - "a loop you believe in" → _red_, turning a fuzzy gate into a binary observable state (the loop goes _red_ on the bug, or it doesn't).
71
+
72
+ You win twice: fewer tokens, and a sharper hook for the agent to hang its thinking on. Assume every document is carrying restatements that leading words retire. Go find them.
73
+
74
+ **Negation** is the failure mode beside this lever: steering by prohibition drags the forbidden behaviour into context and makes it _more_ available, not less. _Don't think of an elephant_, and the elephant is all there is; the negation is a weak modifier the strongly-activated concept overruns, so the ban half-reads as an instruction to do the thing. Prompt the **positive**: state the target behaviour ("write one-line comments") so the banned one is never spoken. A prohibition earns its place only as a hard guardrail you cannot phrase positively; even then, pair it with the positive target so attention lands on what to do.
75
+
76
+ ## Pruning
77
+
78
+ - Keep each meaning in a **single source of truth**: one authoritative place, so changing the behaviour is a one-place edit. **Duplication** (the same meaning in more than one place) costs maintenance and tokens, and inflates a meaning's prominence on the ladder past its real rank. (The accidental inverse of a leading word, which repeats a token on purpose, never the meaning.)
79
+ - The **environment** is a source of truth too (`package.json` scripts, config files, the directory layout, `--help` output), and a document that restates it is a **cache**: a copy of a lookup, earning its load only when the lookup is expensive. Cache what the agent cannot find by looking: the unwritten convention, the reason behind a choice, the gotcha no config confesses. Leave the one-file, one-command lookups to the environment, where they cannot go stale.
80
+ - Check every line for **relevance**: does it still bear on what the document does? A line loses relevance by never bearing on the task (mere exposition, or a branch that should be disclosed) or by going stale as the behaviour or world it describes changes. Shorter documents are easier to keep relevant. Without a pruning discipline the default fate is **sediment**: stale layers that settle because adding feels safe and removing feels risky, until you must core down through them to find what is still live.
81
+ - Hunt **no-ops** sentence by sentence: an instruction the model already obeys by default pays load to say nothing. The test (does it change behaviour versus the default?) is model-relative, not reader-relative: two people disagreeing about a no-op disagree about the default, and settle it by running the document, not by debate. When a sentence fails, delete the whole sentence rather than trim words from it. The test also grades leading words: a word too weak to beat the default (_be thorough_ when the agent is already thorough-ish) is a no-op, and the fix is a stronger word (_relentless_), not a different technique.
@@ -0,0 +1,3 @@
1
+ interface:
2
+ display_name: "Writing for Agents"
3
+ short_description: "Write documents agents consume"