agent-method 1.5.5 → 1.5.6

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.

Potentially problematic release.


This version of agent-method might be problematic. Click here for more details.

Files changed (62) hide show
  1. package/README.md +68 -40
  2. package/bin/wwa.js +35 -9
  3. package/docs/internal/doc-tokens.yaml +452 -0
  4. package/docs/internal/feature-registry.yaml +13 -1
  5. package/lib/cli/casestudy.js +691 -0
  6. package/lib/cli/check.js +1 -1
  7. package/lib/cli/close.js +446 -0
  8. package/lib/cli/completion.js +639 -0
  9. package/lib/cli/digest.js +66 -0
  10. package/lib/cli/docs.js +207 -0
  11. package/lib/cli/helpers.js +49 -2
  12. package/lib/cli/implement.js +159 -0
  13. package/lib/cli/init.js +25 -6
  14. package/lib/cli/plan.js +128 -0
  15. package/lib/cli/refine.js +4 -4
  16. package/lib/cli/review.js +68 -0
  17. package/lib/cli/scan.js +2 -2
  18. package/lib/cli/status.js +1 -1
  19. package/lib/cli/upgrade.js +8 -7
  20. package/lib/init.js +205 -23
  21. package/package.json +10 -3
  22. package/templates/README.md +70 -22
  23. package/templates/entry-points/.cursorrules +142 -13
  24. package/templates/entry-points/AGENT.md +142 -13
  25. package/templates/entry-points/CLAUDE.md +142 -13
  26. package/templates/extensions/analytical-system.md +1 -1
  27. package/templates/extensions/code-project.md +1 -1
  28. package/templates/extensions/data-exploration.md +1 -1
  29. package/templates/full/.context/BASE.md +33 -0
  30. package/templates/full/.context/METHODOLOGY.md +62 -5
  31. package/templates/full/.cursorrules +127 -17
  32. package/templates/full/AGENT.md +127 -17
  33. package/templates/full/CLAUDE.md +127 -17
  34. package/templates/full/Management/DIGEST.md +23 -0
  35. package/templates/full/Management/STATUS.md +46 -0
  36. package/templates/full/PROJECT.md +34 -0
  37. package/templates/full/Reviews/INDEX.md +41 -0
  38. package/templates/full/Reviews/backlog.md +52 -0
  39. package/templates/full/Reviews/plan.md +43 -0
  40. package/templates/full/Reviews/project.md +41 -0
  41. package/templates/full/Reviews/requirements.md +42 -0
  42. package/templates/full/Reviews/roadmap.md +41 -0
  43. package/templates/full/Reviews/state.md +56 -0
  44. package/templates/full/SUMMARY.md +7 -4
  45. package/templates/full/agentWorkflows/INDEX.md +42 -0
  46. package/templates/full/agentWorkflows/observations.md +65 -0
  47. package/templates/full/agentWorkflows/patterns.md +68 -0
  48. package/templates/full/agentWorkflows/sessions.md +92 -0
  49. package/templates/full/intro/README.md +39 -0
  50. package/templates/starter/.context/BASE.md +35 -0
  51. package/templates/starter/.context/METHODOLOGY.md +59 -5
  52. package/templates/starter/.cursorrules +134 -12
  53. package/templates/starter/AGENT.md +134 -12
  54. package/templates/starter/CLAUDE.md +134 -12
  55. package/templates/starter/Management/DIGEST.md +23 -0
  56. package/templates/starter/Management/STATUS.md +46 -0
  57. package/templates/starter/PROJECT.md +34 -0
  58. package/templates/starter/Reviews/INDEX.md +75 -0
  59. package/templates/starter/SUMMARY.md +27 -0
  60. package/templates/starter/agentWorkflows/INDEX.md +61 -0
  61. package/templates/starter/intro/README.md +37 -0
  62. package/templates/full/docs/index.md +0 -46
@@ -21,6 +21,10 @@
21
21
  | **Methodology guidance** | .context/METHODOLOGY.md | -- |
22
22
  | **Phase completion** | SUMMARY.md | SUMMARY.md, STATE.md, ROADMAP.md |
23
23
  | **Backlog / ideas** | todos/backlog.md | todos/backlog.md |
24
+ | **Management overview** | Management/DIGEST.md, Management/STATUS.md, STATE.md | Management/STATUS.md, Management/DIGEST.md |
25
+ | **Project review** | Reviews/INDEX.md, relevant source files | Reviews/ (affected review file) |
26
+ | **Workflow analysis** | agentWorkflows/INDEX.md, SESSION-LOG.md | agentWorkflows/ (affected analysis file) |
27
+ | **Docs update** | .context/DOCS-MAP.md, relevant docs/ files | docs/ files, .context/DOCS-MAP.md |
24
28
 
25
29
  <!-- INSTRUCTION: Replace the {your-domain-type} row with project-specific query types.
26
30
  Each should pair .context/BASE.md with one specialist. Add as many rows as needed. -->
@@ -39,18 +43,126 @@ When a file changes, check this table and update dependent files in the same res
39
43
  | Intelligence layer file exceeds 300 lines | Restructure into index + components subdirectory (keep active content, archive completed sections) |
40
44
  | New domain area | .context/BASE.md, consider new .context/ specialist, this file (if new scoping row) |
41
45
  | Lifecycle stage change | PROJECT-PROFILE.md (update stage + date), STATE.md (record decision) |
42
- | Session close or high-effort task completion | SESSION-LOG.md (append metrics entry — effort, ambiguity, context level, tokens, time, user response, refinement delta, workflow, features, cascades, friction, findings) |
46
+ | Session close or high-effort task completion | SESSION-LOG.md (append metrics entry — effort, ambiguity, context level, tokens, time, user response, refinement delta, workflow, features, cascades, friction, findings). For high-effort tasks also: Management/DIGEST.md (append row — date, task, query, outcome, key changes, decisions, effort, time), Management/STATUS.md (if milestone) |
47
+ | Significant milestone or phase completion | Management/STATUS.md (update current state, recent decisions, health indicators) |
48
+ | New project component or module | .context/DOCS-MAP.md (add component mapping, check scaffolding rules for new docs/ proposals) |
49
+ | docs/ file created or deleted | .context/DOCS-MAP.md (update inventory), docs/index.md (update navigation — create if it doesn't exist yet) |
43
50
 
44
51
  <!-- INSTRUCTION: Add project-specific cascade rules below the universal ones above. -->
45
52
 
53
+ ## Docs maintenance
54
+
55
+ <!-- INSTRUCTION: This table tells the agent when to update human-facing docs.
56
+ For full component-to-docs mapping, see .context/DOCS-MAP.md. -->
57
+
58
+ | Trigger | Update these docs/ files |
59
+ |---------|------------------------|
60
+ | Phase completed | docs/index.md (progress section — create from DOCS-MAP.md if it doesn't exist yet) |
61
+ | Architecture decision | docs/index.md (architecture section), .context/DOCS-MAP.md (if new component) |
62
+ | New project component | .context/DOCS-MAP.md (add mapping), docs/ (per DOCS-MAP.md scaffolding rules) |
63
+ | {structural-change} | {specific docs/ files per DOCS-MAP.md component mapping} |
64
+
46
65
  ## Workflow
47
66
 
48
67
  Select based on query type:
49
68
  - **General task** — Review, Plan, Implement, Document, Update
50
69
  - **Code change** — Review, Plan, Implement, Context-sync, Update
51
70
  - **Context refresh** — Scan, Compare, Update-context, Cascade, Record
52
- - **First session** — Detect, Initialize, Map, Pair, Ready
53
- - **Discovery (brownfield)** — Inventory, Map-dependencies, Extract-patterns, Assess, Bootstrap
71
+ - **First session (greenfield)** — Ask, Populate, Confirm (see onboarding protocol below)
72
+ - **First session (brownfield)** — Scan, Ask, Confirm (see onboarding protocol below)
73
+
74
+ ## First session protocol
75
+
76
+ <!-- AGENT: Follow this protocol on the FIRST session when methodology files contain only template placeholders. -->
77
+
78
+ When PROJECT.md still contains `{placeholder}` text, this is a first session. Guide the user through onboarding — ask questions, show what you'll write, get confirmation before writing each file.
79
+
80
+ ### Greenfield onboarding (no existing codebase)
81
+
82
+ **Stage 1 — Project vision** → populates PROJECT.md
83
+ Ask the user:
84
+ 1. What is your project about? (1-2 sentences)
85
+ 2. Who is it for?
86
+ 3. What problem does it solve?
87
+ 4. What technologies, languages, or frameworks will you use?
88
+ 5. What are 2-3 guiding principles for this project?
89
+
90
+ CHECKPOINT: Draft PROJECT.md from the answers. Show the user the draft. Wait for approval before writing.
91
+
92
+ **Stage 2 — Architecture** → populates .context/BASE.md, PROJECT-PROFILE.md, .context/DOCS-MAP.md
93
+ Ask the user:
94
+ 1. What are the main components or modules?
95
+ 2. How do they connect? (data flow, API calls, event-driven, etc.)
96
+ 3. What is the directory structure? (or what will it be?)
97
+ 4. What are the key dependencies?
98
+
99
+ CHECKPOINT: Draft .context/BASE.md, PROJECT-PROFILE.md, and .context/DOCS-MAP.md (initial component-to-docs mapping based on architecture). Show the user. Wait for approval.
100
+
101
+ **Stage 3 — Goals** → populates ROADMAP.md, PLAN.md
102
+ Ask the user:
103
+ 1. What are your immediate goals? (next 1-3 sessions)
104
+ 2. What does "done" look like for this project?
105
+ 3. Can you break this into 2-4 phases?
106
+
107
+ CHECKPOINT: Draft ROADMAP.md and PLAN.md (first task). Show the user. Wait for approval.
108
+
109
+ **Stage 4 — Starting state** → populates STATE.md
110
+ Ask the user:
111
+ 1. Any decisions already made? (tech choices, architecture, constraints)
112
+ 2. Any known blockers or risks?
113
+ 3. Any open questions you want tracked?
114
+
115
+ CHECKPOINT: Draft STATE.md. Show the user. Wait for approval. Then begin normal work.
116
+
117
+ ### Brownfield onboarding (existing codebase)
118
+
119
+ **Stage 1 — Scan** → reads existing files, writes nothing
120
+ Read: package.json, README, directory structure, key config files, entry points.
121
+ Present findings: "Here's what I found in your project: [summary]. Is this accurate?"
122
+
123
+ CHECKPOINT: Wait for user to confirm or correct your understanding.
124
+
125
+ **Stage 2 — Clarify** → populates PROJECT.md, PROJECT-PROFILE.md
126
+ Ask targeted questions based on what the scan missed:
127
+ 1. What's the intent behind [pattern you found]?
128
+ 2. Are there conventions not captured in config? (naming, structure, etc.)
129
+ 3. What's the current state — active development, maintenance, exploration?
130
+
131
+ CHECKPOINT: Draft PROJECT.md from scan + answers. Show the user. Wait for approval.
132
+
133
+ **Stage 3 — Map** → populates .context/BASE.md, .context/DOCS-MAP.md
134
+ Build codebase map from scan. Ask:
135
+ 1. Are there areas of the codebase I should understand deeply vs. ignore?
136
+ 2. Any architectural decisions I should know about that aren't documented?
137
+ 3. What are the most common types of changes you make?
138
+
139
+ CHECKPOINT: Draft .context/BASE.md and .context/DOCS-MAP.md (component-to-docs mapping from scan results). Show the user. Wait for approval.
140
+
141
+ **Stage 4 — Organize** → proposes entry point customization
142
+ Based on understanding, propose:
143
+ 1. Scoping rules — which query types match this project?
144
+ 2. Specialist context files — which domains need their own .context/ file?
145
+ 3. Cascade rules — what project-specific dependencies exist?
146
+
147
+ CHECKPOINT: Show proposed entry point customizations. Wait for approval before modifying this file.
148
+
149
+ **Stage 5 — Starting state** → populates STATE.md, ROADMAP.md
150
+ Propose initial state based on everything learned:
151
+ 1. Decisions already implicit in the codebase (document them)
152
+ 2. Current position (where is the project in its lifecycle?)
153
+ 3. Immediate goals
154
+
155
+ CHECKPOINT: Draft STATE.md and ROADMAP.md. Show the user. Wait for approval. Then begin normal work.
156
+
157
+ ### Checkpoint rules
158
+
159
+ - NEVER write to a methodology file without showing the user what you will write first
160
+ - At each CHECKPOINT, present the draft as a code block the user can review
161
+ - If the user says "looks good" or similar, write the file
162
+ - If the user edits or corrects, incorporate changes and show the updated draft
163
+ - If the user says "skip", leave the file as template placeholder
164
+ - After all stages complete, summarize what was populated and begin normal work
165
+ - For brownfield: `.context/REGISTRY.md` is deferred — do not create it during onboarding. It will be created automatically when the first file split occurs (reduces first-session cognitive load)
54
166
 
55
167
  ## Interaction level
56
168
 
@@ -70,21 +182,28 @@ tier: standard
70
182
 
71
183
  method_version: 1.5
72
184
  <!-- Tracks which methodology version generated this entry point -->
73
- <!-- Use `npx agent-method status` to compare against latest -->
185
+ <!-- Use `wwa status` to compare against latest -->
74
186
 
75
187
  ## CLI tools (optional)
76
188
 
77
- Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
189
+ Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
78
190
 
79
191
  | When you want to... | Run |
80
192
  |---------------------|-----|
81
- | Validate this entry point | `npx agent-method check` |
82
- | See what type of project this is | `npx agent-method scan` |
83
- | Test how a query routes | `npx agent-method route "your question"` |
84
- | Extract a refinement report | `npx agent-method refine` |
85
- | Check methodology version | `npx agent-method status` |
86
- | Update methodology files | `npx agent-method upgrade` |
87
- | See what an entry point should contain | `npx agent-method init code` / `context` / `data` / `mix` |
193
+ | Validate this entry point | `wwa check` |
194
+ | See what type of project this is | `wwa scan` |
195
+ | Test how a query routes | `wwa route "your question"` |
196
+ | See current plan status | `wwa plan` |
197
+ | Get implementation guidance | `wwa implement` |
198
+ | View project review dashboard | `wwa review` |
199
+ | Show management digest | `wwa digest` |
200
+ | Session close + project snapshot | `wwa close` |
201
+ | Extract a refinement report | `wwa refine` |
202
+ | Extract a case study (with project tokens) | `wwa casestudy` |
203
+ | Check docs coverage | `wwa docs` |
204
+ | Check methodology version | `wwa status` |
205
+ | Update methodology files | `wwa upgrade` |
206
+ | Set up a new project | `wwa init code` / `context` / `data` / `mix` |
88
207
 
89
208
  <!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
90
209
  project setup, or methodology updates. All commands auto-detect project type and find
@@ -99,6 +218,8 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
99
218
  - Surface uncertainty as open questions in STATE.md — never guess silently
100
219
  - Keep intelligence layer files under 300 lines — split into index + components subdirectory when exceeded
101
220
  - Propose plans and wait for approval — the human controls direction
221
+ - Document proportionally — low-effort tasks (status checks, lookups, clarifications) need no STATE.md or SESSION-LOG updates; high-effort tasks get full recording
222
+ - SUMMARY.md is the session audit trail (date, plan, outcome, files, decisions, next). Management digest lives in Management/DIGEST.md
102
223
  - At session close or after any high-effort task, append a metrics entry to SESSION-LOG.md — include effort level, question ambiguity, context level, estimated tokens, time, user response (accepted/edited/revised/rejected/redirected), and for medium/high effort tasks: revision count, refinement magnitude (none/minor/moderate/major/rework), delta categories, and survival rate. Never skip, never read previous entries during normal work
103
224
 
104
225
  ## Do not
@@ -109,5 +230,6 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
109
230
  - Defer STATE.md decision recording to end of session
110
231
  - Skip cascade checks after file changes
111
232
  - Load multiple specialist .context/ files for a single query
233
+ - Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
112
234
 
113
235
  <!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
@@ -21,6 +21,10 @@
21
21
  | **Methodology guidance** | .context/METHODOLOGY.md | -- |
22
22
  | **Phase completion** | SUMMARY.md | SUMMARY.md, STATE.md, ROADMAP.md |
23
23
  | **Backlog / ideas** | todos/backlog.md | todos/backlog.md |
24
+ | **Management overview** | Management/DIGEST.md, Management/STATUS.md, STATE.md | Management/STATUS.md, Management/DIGEST.md |
25
+ | **Project review** | Reviews/INDEX.md, relevant source files | Reviews/ (affected review file) |
26
+ | **Workflow analysis** | agentWorkflows/INDEX.md, SESSION-LOG.md | agentWorkflows/ (affected analysis file) |
27
+ | **Docs update** | .context/DOCS-MAP.md, relevant docs/ files | docs/ files, .context/DOCS-MAP.md |
24
28
 
25
29
  <!-- INSTRUCTION: Replace the {your-domain-type} row with project-specific query types.
26
30
  Each should pair .context/BASE.md with one specialist. Add as many rows as needed. -->
@@ -39,18 +43,126 @@ When a file changes, check this table and update dependent files in the same res
39
43
  | Intelligence layer file exceeds 300 lines | Restructure into index + components subdirectory (keep active content, archive completed sections) |
40
44
  | New domain area | .context/BASE.md, consider new .context/ specialist, this file (if new scoping row) |
41
45
  | Lifecycle stage change | PROJECT-PROFILE.md (update stage + date), STATE.md (record decision) |
42
- | Session close or high-effort task completion | SESSION-LOG.md (append metrics entry — effort, ambiguity, context level, tokens, time, user response, refinement delta, workflow, features, cascades, friction, findings) |
46
+ | Session close or high-effort task completion | SESSION-LOG.md (append metrics entry — effort, ambiguity, context level, tokens, time, user response, refinement delta, workflow, features, cascades, friction, findings). For high-effort tasks also: Management/DIGEST.md (append row — date, task, query, outcome, key changes, decisions, effort, time), Management/STATUS.md (if milestone) |
47
+ | Significant milestone or phase completion | Management/STATUS.md (update current state, recent decisions, health indicators) |
48
+ | New project component or module | .context/DOCS-MAP.md (add component mapping, check scaffolding rules for new docs/ proposals) |
49
+ | docs/ file created or deleted | .context/DOCS-MAP.md (update inventory), docs/index.md (update navigation — create if it doesn't exist yet) |
43
50
 
44
51
  <!-- INSTRUCTION: Add project-specific cascade rules below the universal ones above. -->
45
52
 
53
+ ## Docs maintenance
54
+
55
+ <!-- INSTRUCTION: This table tells the agent when to update human-facing docs.
56
+ For full component-to-docs mapping, see .context/DOCS-MAP.md. -->
57
+
58
+ | Trigger | Update these docs/ files |
59
+ |---------|------------------------|
60
+ | Phase completed | docs/index.md (progress section — create from DOCS-MAP.md if it doesn't exist yet) |
61
+ | Architecture decision | docs/index.md (architecture section), .context/DOCS-MAP.md (if new component) |
62
+ | New project component | .context/DOCS-MAP.md (add mapping), docs/ (per DOCS-MAP.md scaffolding rules) |
63
+ | {structural-change} | {specific docs/ files per DOCS-MAP.md component mapping} |
64
+
46
65
  ## Workflow
47
66
 
48
67
  Select based on query type:
49
68
  - **General task** — Review, Plan, Implement, Document, Update
50
69
  - **Code change** — Review, Plan, Implement, Context-sync, Update
51
70
  - **Context refresh** — Scan, Compare, Update-context, Cascade, Record
52
- - **First session** — Detect, Initialize, Map, Pair, Ready
53
- - **Discovery (brownfield)** — Inventory, Map-dependencies, Extract-patterns, Assess, Bootstrap
71
+ - **First session (greenfield)** — Ask, Populate, Confirm (see onboarding protocol below)
72
+ - **First session (brownfield)** — Scan, Ask, Confirm (see onboarding protocol below)
73
+
74
+ ## First session protocol
75
+
76
+ <!-- AGENT: Follow this protocol on the FIRST session when methodology files contain only template placeholders. -->
77
+
78
+ When PROJECT.md still contains `{placeholder}` text, this is a first session. Guide the user through onboarding — ask questions, show what you'll write, get confirmation before writing each file.
79
+
80
+ ### Greenfield onboarding (no existing codebase)
81
+
82
+ **Stage 1 — Project vision** → populates PROJECT.md
83
+ Ask the user:
84
+ 1. What is your project about? (1-2 sentences)
85
+ 2. Who is it for?
86
+ 3. What problem does it solve?
87
+ 4. What technologies, languages, or frameworks will you use?
88
+ 5. What are 2-3 guiding principles for this project?
89
+
90
+ CHECKPOINT: Draft PROJECT.md from the answers. Show the user the draft. Wait for approval before writing.
91
+
92
+ **Stage 2 — Architecture** → populates .context/BASE.md, PROJECT-PROFILE.md, .context/DOCS-MAP.md
93
+ Ask the user:
94
+ 1. What are the main components or modules?
95
+ 2. How do they connect? (data flow, API calls, event-driven, etc.)
96
+ 3. What is the directory structure? (or what will it be?)
97
+ 4. What are the key dependencies?
98
+
99
+ CHECKPOINT: Draft .context/BASE.md, PROJECT-PROFILE.md, and .context/DOCS-MAP.md (initial component-to-docs mapping based on architecture). Show the user. Wait for approval.
100
+
101
+ **Stage 3 — Goals** → populates ROADMAP.md, PLAN.md
102
+ Ask the user:
103
+ 1. What are your immediate goals? (next 1-3 sessions)
104
+ 2. What does "done" look like for this project?
105
+ 3. Can you break this into 2-4 phases?
106
+
107
+ CHECKPOINT: Draft ROADMAP.md and PLAN.md (first task). Show the user. Wait for approval.
108
+
109
+ **Stage 4 — Starting state** → populates STATE.md
110
+ Ask the user:
111
+ 1. Any decisions already made? (tech choices, architecture, constraints)
112
+ 2. Any known blockers or risks?
113
+ 3. Any open questions you want tracked?
114
+
115
+ CHECKPOINT: Draft STATE.md. Show the user. Wait for approval. Then begin normal work.
116
+
117
+ ### Brownfield onboarding (existing codebase)
118
+
119
+ **Stage 1 — Scan** → reads existing files, writes nothing
120
+ Read: package.json, README, directory structure, key config files, entry points.
121
+ Present findings: "Here's what I found in your project: [summary]. Is this accurate?"
122
+
123
+ CHECKPOINT: Wait for user to confirm or correct your understanding.
124
+
125
+ **Stage 2 — Clarify** → populates PROJECT.md, PROJECT-PROFILE.md
126
+ Ask targeted questions based on what the scan missed:
127
+ 1. What's the intent behind [pattern you found]?
128
+ 2. Are there conventions not captured in config? (naming, structure, etc.)
129
+ 3. What's the current state — active development, maintenance, exploration?
130
+
131
+ CHECKPOINT: Draft PROJECT.md from scan + answers. Show the user. Wait for approval.
132
+
133
+ **Stage 3 — Map** → populates .context/BASE.md, .context/DOCS-MAP.md
134
+ Build codebase map from scan. Ask:
135
+ 1. Are there areas of the codebase I should understand deeply vs. ignore?
136
+ 2. Any architectural decisions I should know about that aren't documented?
137
+ 3. What are the most common types of changes you make?
138
+
139
+ CHECKPOINT: Draft .context/BASE.md and .context/DOCS-MAP.md (component-to-docs mapping from scan results). Show the user. Wait for approval.
140
+
141
+ **Stage 4 — Organize** → proposes entry point customization
142
+ Based on understanding, propose:
143
+ 1. Scoping rules — which query types match this project?
144
+ 2. Specialist context files — which domains need their own .context/ file?
145
+ 3. Cascade rules — what project-specific dependencies exist?
146
+
147
+ CHECKPOINT: Show proposed entry point customizations. Wait for approval before modifying this file.
148
+
149
+ **Stage 5 — Starting state** → populates STATE.md, ROADMAP.md
150
+ Propose initial state based on everything learned:
151
+ 1. Decisions already implicit in the codebase (document them)
152
+ 2. Current position (where is the project in its lifecycle?)
153
+ 3. Immediate goals
154
+
155
+ CHECKPOINT: Draft STATE.md and ROADMAP.md. Show the user. Wait for approval. Then begin normal work.
156
+
157
+ ### Checkpoint rules
158
+
159
+ - NEVER write to a methodology file without showing the user what you will write first
160
+ - At each CHECKPOINT, present the draft as a code block the user can review
161
+ - If the user says "looks good" or similar, write the file
162
+ - If the user edits or corrects, incorporate changes and show the updated draft
163
+ - If the user says "skip", leave the file as template placeholder
164
+ - After all stages complete, summarize what was populated and begin normal work
165
+ - For brownfield: `.context/REGISTRY.md` is deferred — do not create it during onboarding. It will be created automatically when the first file split occurs (reduces first-session cognitive load)
54
166
 
55
167
  ## Interaction level
56
168
 
@@ -70,21 +182,28 @@ tier: standard
70
182
 
71
183
  method_version: 1.5
72
184
  <!-- Tracks which methodology version generated this entry point -->
73
- <!-- Use `npx agent-method status` to compare against latest -->
185
+ <!-- Use `wwa status` to compare against latest -->
74
186
 
75
187
  ## CLI tools (optional)
76
188
 
77
- Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
189
+ Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
78
190
 
79
191
  | When you want to... | Run |
80
192
  |---------------------|-----|
81
- | Validate this entry point | `npx agent-method check` |
82
- | See what type of project this is | `npx agent-method scan` |
83
- | Test how a query routes | `npx agent-method route "your question"` |
84
- | Extract a refinement report | `npx agent-method refine` |
85
- | Check methodology version | `npx agent-method status` |
86
- | Update methodology files | `npx agent-method upgrade` |
87
- | See what an entry point should contain | `npx agent-method init code` / `context` / `data` / `mix` |
193
+ | Validate this entry point | `wwa check` |
194
+ | See what type of project this is | `wwa scan` |
195
+ | Test how a query routes | `wwa route "your question"` |
196
+ | See current plan status | `wwa plan` |
197
+ | Get implementation guidance | `wwa implement` |
198
+ | View project review dashboard | `wwa review` |
199
+ | Show management digest | `wwa digest` |
200
+ | Session close + project snapshot | `wwa close` |
201
+ | Extract a refinement report | `wwa refine` |
202
+ | Extract a case study (with project tokens) | `wwa casestudy` |
203
+ | Check docs coverage | `wwa docs` |
204
+ | Check methodology version | `wwa status` |
205
+ | Update methodology files | `wwa upgrade` |
206
+ | Set up a new project | `wwa init code` / `context` / `data` / `mix` |
88
207
 
89
208
  <!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
90
209
  project setup, or methodology updates. All commands auto-detect project type and find
@@ -99,6 +218,8 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
99
218
  - Surface uncertainty as open questions in STATE.md — never guess silently
100
219
  - Keep intelligence layer files under 300 lines — split into index + components subdirectory when exceeded
101
220
  - Propose plans and wait for approval — the human controls direction
221
+ - Document proportionally — low-effort tasks (status checks, lookups, clarifications) need no STATE.md or SESSION-LOG updates; high-effort tasks get full recording
222
+ - SUMMARY.md is the session audit trail (date, plan, outcome, files, decisions, next). Management digest lives in Management/DIGEST.md
102
223
  - At session close or after any high-effort task, append a metrics entry to SESSION-LOG.md — include effort level, question ambiguity, context level, estimated tokens, time, user response (accepted/edited/revised/rejected/redirected), and for medium/high effort tasks: revision count, refinement magnitude (none/minor/moderate/major/rework), delta categories, and survival rate. Never skip, never read previous entries during normal work
103
224
 
104
225
  ## Do not
@@ -109,5 +230,6 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
109
230
  - Defer STATE.md decision recording to end of session
110
231
  - Skip cascade checks after file changes
111
232
  - Load multiple specialist .context/ files for a single query
233
+ - Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
112
234
 
113
235
  <!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
@@ -21,6 +21,10 @@
21
21
  | **Methodology guidance** | .context/METHODOLOGY.md | -- |
22
22
  | **Phase completion** | SUMMARY.md | SUMMARY.md, STATE.md, ROADMAP.md |
23
23
  | **Backlog / ideas** | todos/backlog.md | todos/backlog.md |
24
+ | **Management overview** | Management/DIGEST.md, Management/STATUS.md, STATE.md | Management/STATUS.md, Management/DIGEST.md |
25
+ | **Project review** | Reviews/INDEX.md, relevant source files | Reviews/ (affected review file) |
26
+ | **Workflow analysis** | agentWorkflows/INDEX.md, SESSION-LOG.md | agentWorkflows/ (affected analysis file) |
27
+ | **Docs update** | .context/DOCS-MAP.md, relevant docs/ files | docs/ files, .context/DOCS-MAP.md |
24
28
 
25
29
  <!-- INSTRUCTION: Replace the {your-domain-type} row with project-specific query types.
26
30
  Each should pair .context/BASE.md with one specialist. Add as many rows as needed. -->
@@ -39,18 +43,126 @@ When a file changes, check this table and update dependent files in the same res
39
43
  | Intelligence layer file exceeds 300 lines | Restructure into index + components subdirectory (keep active content, archive completed sections) |
40
44
  | New domain area | .context/BASE.md, consider new .context/ specialist, this file (if new scoping row) |
41
45
  | Lifecycle stage change | PROJECT-PROFILE.md (update stage + date), STATE.md (record decision) |
42
- | Session close or high-effort task completion | SESSION-LOG.md (append metrics entry — effort, ambiguity, context level, tokens, time, user response, refinement delta, workflow, features, cascades, friction, findings) |
46
+ | Session close or high-effort task completion | SESSION-LOG.md (append metrics entry — effort, ambiguity, context level, tokens, time, user response, refinement delta, workflow, features, cascades, friction, findings). For high-effort tasks also: Management/DIGEST.md (append row — date, task, query, outcome, key changes, decisions, effort, time), Management/STATUS.md (if milestone) |
47
+ | Significant milestone or phase completion | Management/STATUS.md (update current state, recent decisions, health indicators) |
48
+ | New project component or module | .context/DOCS-MAP.md (add component mapping, check scaffolding rules for new docs/ proposals) |
49
+ | docs/ file created or deleted | .context/DOCS-MAP.md (update inventory), docs/index.md (update navigation — create if it doesn't exist yet) |
43
50
 
44
51
  <!-- INSTRUCTION: Add project-specific cascade rules below the universal ones above. -->
45
52
 
53
+ ## Docs maintenance
54
+
55
+ <!-- INSTRUCTION: This table tells the agent when to update human-facing docs.
56
+ For full component-to-docs mapping, see .context/DOCS-MAP.md. -->
57
+
58
+ | Trigger | Update these docs/ files |
59
+ |---------|------------------------|
60
+ | Phase completed | docs/index.md (progress section — create from DOCS-MAP.md if it doesn't exist yet) |
61
+ | Architecture decision | docs/index.md (architecture section), .context/DOCS-MAP.md (if new component) |
62
+ | New project component | .context/DOCS-MAP.md (add mapping), docs/ (per DOCS-MAP.md scaffolding rules) |
63
+ | {structural-change} | {specific docs/ files per DOCS-MAP.md component mapping} |
64
+
46
65
  ## Workflow
47
66
 
48
67
  Select based on query type:
49
68
  - **General task** — Review, Plan, Implement, Document, Update
50
69
  - **Code change** — Review, Plan, Implement, Context-sync, Update
51
70
  - **Context refresh** — Scan, Compare, Update-context, Cascade, Record
52
- - **First session** — Detect, Initialize, Map, Pair, Ready
53
- - **Discovery (brownfield)** — Inventory, Map-dependencies, Extract-patterns, Assess, Bootstrap
71
+ - **First session (greenfield)** — Ask, Populate, Confirm (see onboarding protocol below)
72
+ - **First session (brownfield)** — Scan, Ask, Confirm (see onboarding protocol below)
73
+
74
+ ## First session protocol
75
+
76
+ <!-- AGENT: Follow this protocol on the FIRST session when methodology files contain only template placeholders. -->
77
+
78
+ When PROJECT.md still contains `{placeholder}` text, this is a first session. Guide the user through onboarding — ask questions, show what you'll write, get confirmation before writing each file.
79
+
80
+ ### Greenfield onboarding (no existing codebase)
81
+
82
+ **Stage 1 — Project vision** → populates PROJECT.md
83
+ Ask the user:
84
+ 1. What is your project about? (1-2 sentences)
85
+ 2. Who is it for?
86
+ 3. What problem does it solve?
87
+ 4. What technologies, languages, or frameworks will you use?
88
+ 5. What are 2-3 guiding principles for this project?
89
+
90
+ CHECKPOINT: Draft PROJECT.md from the answers. Show the user the draft. Wait for approval before writing.
91
+
92
+ **Stage 2 — Architecture** → populates .context/BASE.md, PROJECT-PROFILE.md, .context/DOCS-MAP.md
93
+ Ask the user:
94
+ 1. What are the main components or modules?
95
+ 2. How do they connect? (data flow, API calls, event-driven, etc.)
96
+ 3. What is the directory structure? (or what will it be?)
97
+ 4. What are the key dependencies?
98
+
99
+ CHECKPOINT: Draft .context/BASE.md, PROJECT-PROFILE.md, and .context/DOCS-MAP.md (initial component-to-docs mapping based on architecture). Show the user. Wait for approval.
100
+
101
+ **Stage 3 — Goals** → populates ROADMAP.md, PLAN.md
102
+ Ask the user:
103
+ 1. What are your immediate goals? (next 1-3 sessions)
104
+ 2. What does "done" look like for this project?
105
+ 3. Can you break this into 2-4 phases?
106
+
107
+ CHECKPOINT: Draft ROADMAP.md and PLAN.md (first task). Show the user. Wait for approval.
108
+
109
+ **Stage 4 — Starting state** → populates STATE.md
110
+ Ask the user:
111
+ 1. Any decisions already made? (tech choices, architecture, constraints)
112
+ 2. Any known blockers or risks?
113
+ 3. Any open questions you want tracked?
114
+
115
+ CHECKPOINT: Draft STATE.md. Show the user. Wait for approval. Then begin normal work.
116
+
117
+ ### Brownfield onboarding (existing codebase)
118
+
119
+ **Stage 1 — Scan** → reads existing files, writes nothing
120
+ Read: package.json, README, directory structure, key config files, entry points.
121
+ Present findings: "Here's what I found in your project: [summary]. Is this accurate?"
122
+
123
+ CHECKPOINT: Wait for user to confirm or correct your understanding.
124
+
125
+ **Stage 2 — Clarify** → populates PROJECT.md, PROJECT-PROFILE.md
126
+ Ask targeted questions based on what the scan missed:
127
+ 1. What's the intent behind [pattern you found]?
128
+ 2. Are there conventions not captured in config? (naming, structure, etc.)
129
+ 3. What's the current state — active development, maintenance, exploration?
130
+
131
+ CHECKPOINT: Draft PROJECT.md from scan + answers. Show the user. Wait for approval.
132
+
133
+ **Stage 3 — Map** → populates .context/BASE.md, .context/DOCS-MAP.md
134
+ Build codebase map from scan. Ask:
135
+ 1. Are there areas of the codebase I should understand deeply vs. ignore?
136
+ 2. Any architectural decisions I should know about that aren't documented?
137
+ 3. What are the most common types of changes you make?
138
+
139
+ CHECKPOINT: Draft .context/BASE.md and .context/DOCS-MAP.md (component-to-docs mapping from scan results). Show the user. Wait for approval.
140
+
141
+ **Stage 4 — Organize** → proposes entry point customization
142
+ Based on understanding, propose:
143
+ 1. Scoping rules — which query types match this project?
144
+ 2. Specialist context files — which domains need their own .context/ file?
145
+ 3. Cascade rules — what project-specific dependencies exist?
146
+
147
+ CHECKPOINT: Show proposed entry point customizations. Wait for approval before modifying this file.
148
+
149
+ **Stage 5 — Starting state** → populates STATE.md, ROADMAP.md
150
+ Propose initial state based on everything learned:
151
+ 1. Decisions already implicit in the codebase (document them)
152
+ 2. Current position (where is the project in its lifecycle?)
153
+ 3. Immediate goals
154
+
155
+ CHECKPOINT: Draft STATE.md and ROADMAP.md. Show the user. Wait for approval. Then begin normal work.
156
+
157
+ ### Checkpoint rules
158
+
159
+ - NEVER write to a methodology file without showing the user what you will write first
160
+ - At each CHECKPOINT, present the draft as a code block the user can review
161
+ - If the user says "looks good" or similar, write the file
162
+ - If the user edits or corrects, incorporate changes and show the updated draft
163
+ - If the user says "skip", leave the file as template placeholder
164
+ - After all stages complete, summarize what was populated and begin normal work
165
+ - For brownfield: `.context/REGISTRY.md` is deferred — do not create it during onboarding. It will be created automatically when the first file split occurs (reduces first-session cognitive load)
54
166
 
55
167
  ## Interaction level
56
168
 
@@ -70,21 +182,28 @@ tier: standard
70
182
 
71
183
  method_version: 1.5
72
184
  <!-- Tracks which methodology version generated this entry point -->
73
- <!-- Use `npx agent-method status` to compare against latest -->
185
+ <!-- Use `wwa status` to compare against latest -->
74
186
 
75
187
  ## CLI tools (optional)
76
188
 
77
- Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
189
+ Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
78
190
 
79
191
  | When you want to... | Run |
80
192
  |---------------------|-----|
81
- | Validate this entry point | `npx agent-method check` |
82
- | See what type of project this is | `npx agent-method scan` |
83
- | Test how a query routes | `npx agent-method route "your question"` |
84
- | Extract a refinement report | `npx agent-method refine` |
85
- | Check methodology version | `npx agent-method status` |
86
- | Update methodology files | `npx agent-method upgrade` |
87
- | See what an entry point should contain | `npx agent-method init code` / `context` / `data` / `mix` |
193
+ | Validate this entry point | `wwa check` |
194
+ | See what type of project this is | `wwa scan` |
195
+ | Test how a query routes | `wwa route "your question"` |
196
+ | See current plan status | `wwa plan` |
197
+ | Get implementation guidance | `wwa implement` |
198
+ | View project review dashboard | `wwa review` |
199
+ | Show management digest | `wwa digest` |
200
+ | Session close + project snapshot | `wwa close` |
201
+ | Extract a refinement report | `wwa refine` |
202
+ | Extract a case study (with project tokens) | `wwa casestudy` |
203
+ | Check docs coverage | `wwa docs` |
204
+ | Check methodology version | `wwa status` |
205
+ | Update methodology files | `wwa upgrade` |
206
+ | Set up a new project | `wwa init code` / `context` / `data` / `mix` |
88
207
 
89
208
  <!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
90
209
  project setup, or methodology updates. All commands auto-detect project type and find
@@ -99,6 +218,8 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
99
218
  - Surface uncertainty as open questions in STATE.md — never guess silently
100
219
  - Keep intelligence layer files under 300 lines — split into index + components subdirectory when exceeded
101
220
  - Propose plans and wait for approval — the human controls direction
221
+ - Document proportionally — low-effort tasks (status checks, lookups, clarifications) need no STATE.md or SESSION-LOG updates; high-effort tasks get full recording
222
+ - SUMMARY.md is the session audit trail (date, plan, outcome, files, decisions, next). Management digest lives in Management/DIGEST.md
102
223
  - At session close or after any high-effort task, append a metrics entry to SESSION-LOG.md — include effort level, question ambiguity, context level, estimated tokens, time, user response (accepted/edited/revised/rejected/redirected), and for medium/high effort tasks: revision count, refinement magnitude (none/minor/moderate/major/rework), delta categories, and survival rate. Never skip, never read previous entries during normal work
103
224
 
104
225
  ## Do not
@@ -109,5 +230,6 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
109
230
  - Defer STATE.md decision recording to end of session
110
231
  - Skip cascade checks after file changes
111
232
  - Load multiple specialist .context/ files for a single query
233
+ - Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
112
234
 
113
235
  <!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
@@ -0,0 +1,23 @@
1
+ # Management Digest
2
+
3
+ <!-- AGENT: Append a row for every HIGH-EFFORT task only.
4
+ This is the primary management-facing project record — managers and leads
5
+ read this to understand what significant work happened, without parsing
6
+ detailed session logs or operational files.
7
+
8
+ Low-effort tasks (lookups, status checks, clarifications) are NOT recorded here.
9
+ See SESSION-LOG.md for complete session data. -->
10
+
11
+ ## What qualifies as high-effort
12
+
13
+ - Multi-file changes (3+ files)
14
+ - Architectural or design decisions
15
+ - Phase completions
16
+ - Complex queries requiring research or multi-step execution
17
+ - New feature implementations
18
+
19
+ ## Digest
20
+
21
+ | Date | Task | Query | Outcome | Key Changes | Decisions | Effort | Time |
22
+ |------|------|-------|---------|-------------|-----------|--------|------|
23
+ <!-- Rows added automatically by agent for high-effort tasks -->
@@ -0,0 +1,46 @@
1
+ # Project Status
2
+
3
+ <!-- AGENT: Update this file after significant milestones (phase completions,
4
+ architectural decisions, blocker changes). This is the management-facing
5
+ health snapshot — read by leads to understand project state at a glance.
6
+
7
+ Do NOT update for routine work. Only update when the project's overall
8
+ status, direction, or risk profile changes. -->
9
+
10
+ ## Current state
11
+
12
+ | Field | Value |
13
+ |-------|-------|
14
+ | Phase | {current phase} |
15
+ | Status | {active / blocked / complete} |
16
+ | Active work | {brief description of current task} |
17
+ | Last milestone | {most recent completed phase or significant deliverable} |
18
+ | Next milestone | {what's coming next} |
19
+
20
+ ## Recent decisions
21
+
22
+ <!-- AGENT: Keep the 5 most recent significant decisions here.
23
+ Full decision history lives in STATE.md. -->
24
+
25
+ | Date | Decision | Impact |
26
+ |------|----------|--------|
27
+ <!-- Last 5 significant decisions -->
28
+
29
+ ## Blockers & risks
30
+
31
+ <!-- AGENT: List active blockers and known risks. Remove when resolved. -->
32
+
33
+ | Type | Description | Since | Severity |
34
+ |------|-------------|-------|----------|
35
+ <!-- {blocker/risk} | {description} | {date} | {high/medium/low} -->
36
+
37
+ ## Health indicators
38
+
39
+ <!-- AGENT: Update these after each high-effort task or milestone. -->
40
+
41
+ | Indicator | Status | Notes |
42
+ |-----------|--------|-------|
43
+ | Scope | {stable / expanding / contracting} | {brief note} |
44
+ | Velocity | {steady / accelerating / slowing} | {brief note} |
45
+ | Technical debt | {low / medium / high} | {brief note} |
46
+ | Context freshness | {current / slightly stale / stale} | {last refresh date} |