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.
- package/README.md +68 -40
- package/bin/wwa.js +35 -9
- package/docs/internal/doc-tokens.yaml +452 -0
- package/docs/internal/feature-registry.yaml +13 -1
- package/lib/cli/casestudy.js +691 -0
- package/lib/cli/check.js +1 -1
- package/lib/cli/close.js +446 -0
- package/lib/cli/completion.js +639 -0
- package/lib/cli/digest.js +66 -0
- package/lib/cli/docs.js +207 -0
- package/lib/cli/helpers.js +49 -2
- package/lib/cli/implement.js +159 -0
- package/lib/cli/init.js +25 -6
- package/lib/cli/plan.js +128 -0
- package/lib/cli/refine.js +4 -4
- package/lib/cli/review.js +68 -0
- package/lib/cli/scan.js +2 -2
- package/lib/cli/status.js +1 -1
- package/lib/cli/upgrade.js +8 -7
- package/lib/init.js +205 -23
- package/package.json +10 -3
- package/templates/README.md +70 -22
- package/templates/entry-points/.cursorrules +142 -13
- package/templates/entry-points/AGENT.md +142 -13
- package/templates/entry-points/CLAUDE.md +142 -13
- package/templates/extensions/analytical-system.md +1 -1
- package/templates/extensions/code-project.md +1 -1
- package/templates/extensions/data-exploration.md +1 -1
- package/templates/full/.context/BASE.md +33 -0
- package/templates/full/.context/METHODOLOGY.md +62 -5
- package/templates/full/.cursorrules +127 -17
- package/templates/full/AGENT.md +127 -17
- package/templates/full/CLAUDE.md +127 -17
- package/templates/full/Management/DIGEST.md +23 -0
- package/templates/full/Management/STATUS.md +46 -0
- package/templates/full/PROJECT.md +34 -0
- package/templates/full/Reviews/INDEX.md +41 -0
- package/templates/full/Reviews/backlog.md +52 -0
- package/templates/full/Reviews/plan.md +43 -0
- package/templates/full/Reviews/project.md +41 -0
- package/templates/full/Reviews/requirements.md +42 -0
- package/templates/full/Reviews/roadmap.md +41 -0
- package/templates/full/Reviews/state.md +56 -0
- package/templates/full/SUMMARY.md +7 -4
- package/templates/full/agentWorkflows/INDEX.md +42 -0
- package/templates/full/agentWorkflows/observations.md +65 -0
- package/templates/full/agentWorkflows/patterns.md +68 -0
- package/templates/full/agentWorkflows/sessions.md +92 -0
- package/templates/full/intro/README.md +39 -0
- package/templates/starter/.context/BASE.md +35 -0
- package/templates/starter/.context/METHODOLOGY.md +59 -5
- package/templates/starter/.cursorrules +134 -12
- package/templates/starter/AGENT.md +134 -12
- package/templates/starter/CLAUDE.md +134 -12
- package/templates/starter/Management/DIGEST.md +23 -0
- package/templates/starter/Management/STATUS.md +46 -0
- package/templates/starter/PROJECT.md +34 -0
- package/templates/starter/Reviews/INDEX.md +75 -0
- package/templates/starter/SUMMARY.md +27 -0
- package/templates/starter/agentWorkflows/INDEX.md +61 -0
- package/templates/starter/intro/README.md +37 -0
- package/templates/full/docs/index.md +0 -46
package/templates/full/AGENT.md
CHANGED
|
@@ -22,6 +22,10 @@
|
|
|
22
22
|
| **Methodology guidance** | .context/METHODOLOGY.md | -- |
|
|
23
23
|
| **Phase completion** | SUMMARY.md | SUMMARY.md, STATE.md, ROADMAP.md |
|
|
24
24
|
| **Backlog / ideas** | todos/backlog.md | todos/backlog.md |
|
|
25
|
+
| **Management overview** | Management/DIGEST.md, Management/STATUS.md, STATE.md | Management/STATUS.md, Management/DIGEST.md |
|
|
26
|
+
| **Project review** | Reviews/INDEX.md, relevant source files | Reviews/ (affected review file) |
|
|
27
|
+
| **Workflow analysis** | agentWorkflows/INDEX.md, SESSION-LOG.md | agentWorkflows/ (affected analysis file) |
|
|
28
|
+
| **Docs update** | .context/DOCS-MAP.md, relevant docs/ files | docs/ files, .context/DOCS-MAP.md |
|
|
25
29
|
|
|
26
30
|
<!-- INSTRUCTION: Replace the {your-domain-type} row with project-specific query types.
|
|
27
31
|
Each should pair .context/BASE.md with one specialist. Add as many rows as needed. -->
|
|
@@ -41,20 +45,24 @@ When a file changes, check this table and update dependent files in the same res
|
|
|
41
45
|
| File split, created, deleted, or renamed | .context/REGISTRY.md (file tree, topic index, structural log) |
|
|
42
46
|
| New domain area | .context/BASE.md, consider new .context/ specialist, this file (if new scoping row) |
|
|
43
47
|
| Lifecycle stage change | PROJECT-PROFILE.md (update stage + date), STATE.md (record decision) |
|
|
44
|
-
| 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) |
|
|
48
|
+
| 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) |
|
|
49
|
+
| Significant milestone or phase completion | Management/STATUS.md (update current state, recent decisions, health indicators) |
|
|
50
|
+
| New project component or module | .context/DOCS-MAP.md (add component mapping, check scaffolding rules for new docs/ proposals) |
|
|
51
|
+
| docs/ file created or deleted | .context/DOCS-MAP.md (update inventory), docs/index.md (update navigation — create if it doesn't exist yet) |
|
|
45
52
|
|
|
46
53
|
<!-- INSTRUCTION: Add project-specific cascade rules below the universal ones above. -->
|
|
47
54
|
|
|
48
55
|
## Docs maintenance
|
|
49
56
|
|
|
50
57
|
<!-- INSTRUCTION: This table tells the agent when to update human-facing docs.
|
|
51
|
-
|
|
58
|
+
For full component-to-docs mapping, see .context/DOCS-MAP.md. -->
|
|
52
59
|
|
|
53
60
|
| Trigger | Update these docs/ files |
|
|
54
61
|
|---------|------------------------|
|
|
55
|
-
| Phase completed | docs/index.md (progress section) |
|
|
56
|
-
| Architecture decision | docs/index.md (architecture section) |
|
|
57
|
-
|
|
|
62
|
+
| Phase completed | docs/index.md (progress section — create from DOCS-MAP.md if it doesn't exist yet) |
|
|
63
|
+
| Architecture decision | docs/index.md (architecture section), .context/DOCS-MAP.md (if new component) |
|
|
64
|
+
| New project component | .context/DOCS-MAP.md (add mapping), docs/ (per DOCS-MAP.md scaffolding rules) |
|
|
65
|
+
| {structural-change} | {specific docs/ files per DOCS-MAP.md component mapping} |
|
|
58
66
|
|
|
59
67
|
## Workflow
|
|
60
68
|
|
|
@@ -62,8 +70,101 @@ Select based on query type:
|
|
|
62
70
|
- **General task** — Review, Plan, Implement, Document, Update
|
|
63
71
|
- **Code change** — Review, Plan, Implement, Context-sync, Update
|
|
64
72
|
- **Context refresh** — Scan, Compare, Update-context, Cascade, Record
|
|
65
|
-
- **First session** —
|
|
66
|
-
- **
|
|
73
|
+
- **First session (greenfield)** — Ask, Populate, Confirm (see onboarding protocol below)
|
|
74
|
+
- **First session (brownfield)** — Scan, Ask, Confirm (see onboarding protocol below)
|
|
75
|
+
|
|
76
|
+
## First session protocol
|
|
77
|
+
|
|
78
|
+
<!-- AGENT: Follow this protocol on the FIRST session when methodology files contain only template placeholders. -->
|
|
79
|
+
|
|
80
|
+
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.
|
|
81
|
+
|
|
82
|
+
### Greenfield onboarding (no existing codebase)
|
|
83
|
+
|
|
84
|
+
**Stage 1 — Project vision** → populates PROJECT.md
|
|
85
|
+
Ask the user:
|
|
86
|
+
1. What is your project about? (1-2 sentences)
|
|
87
|
+
2. Who is it for?
|
|
88
|
+
3. What problem does it solve?
|
|
89
|
+
4. What technologies, languages, or frameworks will you use?
|
|
90
|
+
5. What are 2-3 guiding principles for this project?
|
|
91
|
+
|
|
92
|
+
CHECKPOINT: Draft PROJECT.md from the answers. Show the user the draft. Wait for approval before writing.
|
|
93
|
+
|
|
94
|
+
**Stage 2 — Architecture** → populates .context/BASE.md, PROJECT-PROFILE.md, .context/DOCS-MAP.md
|
|
95
|
+
Ask the user:
|
|
96
|
+
1. What are the main components or modules?
|
|
97
|
+
2. How do they connect? (data flow, API calls, event-driven, etc.)
|
|
98
|
+
3. What is the directory structure? (or what will it be?)
|
|
99
|
+
4. What are the key dependencies?
|
|
100
|
+
|
|
101
|
+
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.
|
|
102
|
+
|
|
103
|
+
**Stage 3 — Goals** → populates ROADMAP.md, PLAN.md
|
|
104
|
+
Ask the user:
|
|
105
|
+
1. What are your immediate goals? (next 1-3 sessions)
|
|
106
|
+
2. What does "done" look like for this project?
|
|
107
|
+
3. Can you break this into 2-4 phases?
|
|
108
|
+
|
|
109
|
+
CHECKPOINT: Draft ROADMAP.md and PLAN.md (first task). Show the user. Wait for approval.
|
|
110
|
+
|
|
111
|
+
**Stage 4 — Starting state** → populates STATE.md
|
|
112
|
+
Ask the user:
|
|
113
|
+
1. Any decisions already made? (tech choices, architecture, constraints)
|
|
114
|
+
2. Any known blockers or risks?
|
|
115
|
+
3. Any open questions you want tracked?
|
|
116
|
+
|
|
117
|
+
CHECKPOINT: Draft STATE.md. Show the user. Wait for approval. Then begin normal work.
|
|
118
|
+
|
|
119
|
+
### Brownfield onboarding (existing codebase)
|
|
120
|
+
|
|
121
|
+
**Stage 1 — Scan** → reads existing files, writes nothing
|
|
122
|
+
Read: package.json, README, directory structure, key config files, entry points.
|
|
123
|
+
Present findings: "Here's what I found in your project: [summary]. Is this accurate?"
|
|
124
|
+
|
|
125
|
+
CHECKPOINT: Wait for user to confirm or correct your understanding.
|
|
126
|
+
|
|
127
|
+
**Stage 2 — Clarify** → populates PROJECT.md, PROJECT-PROFILE.md
|
|
128
|
+
Ask targeted questions based on what the scan missed:
|
|
129
|
+
1. What's the intent behind [pattern you found]?
|
|
130
|
+
2. Are there conventions not captured in config? (naming, structure, etc.)
|
|
131
|
+
3. What's the current state — active development, maintenance, exploration?
|
|
132
|
+
|
|
133
|
+
CHECKPOINT: Draft PROJECT.md from scan + answers. Show the user. Wait for approval.
|
|
134
|
+
|
|
135
|
+
**Stage 3 — Map** → populates .context/BASE.md, .context/DOCS-MAP.md
|
|
136
|
+
Build codebase map from scan. Ask:
|
|
137
|
+
1. Are there areas of the codebase I should understand deeply vs. ignore?
|
|
138
|
+
2. Any architectural decisions I should know about that aren't documented?
|
|
139
|
+
3. What are the most common types of changes you make?
|
|
140
|
+
|
|
141
|
+
CHECKPOINT: Draft .context/BASE.md and .context/DOCS-MAP.md (component-to-docs mapping from scan results). Show the user. Wait for approval.
|
|
142
|
+
|
|
143
|
+
**Stage 4 — Organize** → proposes entry point customization
|
|
144
|
+
Based on understanding, propose:
|
|
145
|
+
1. Scoping rules — which query types match this project?
|
|
146
|
+
2. Specialist context files — which domains need their own .context/ file?
|
|
147
|
+
3. Cascade rules — what project-specific dependencies exist?
|
|
148
|
+
|
|
149
|
+
CHECKPOINT: Show proposed entry point customizations. Wait for approval before modifying this file.
|
|
150
|
+
|
|
151
|
+
**Stage 5 — Starting state** → populates STATE.md, ROADMAP.md
|
|
152
|
+
Propose initial state based on everything learned:
|
|
153
|
+
1. Decisions already implicit in the codebase (document them)
|
|
154
|
+
2. Current position (where is the project in its lifecycle?)
|
|
155
|
+
3. Immediate goals
|
|
156
|
+
|
|
157
|
+
CHECKPOINT: Draft STATE.md and ROADMAP.md. Show the user. Wait for approval. Then begin normal work.
|
|
158
|
+
|
|
159
|
+
### Checkpoint rules
|
|
160
|
+
|
|
161
|
+
- NEVER write to a methodology file without showing the user what you will write first
|
|
162
|
+
- At each CHECKPOINT, present the draft as a code block the user can review
|
|
163
|
+
- If the user says "looks good" or similar, write the file
|
|
164
|
+
- If the user edits or corrects, incorporate changes and show the updated draft
|
|
165
|
+
- If the user says "skip", leave the file as template placeholder
|
|
166
|
+
- After all stages complete, summarize what was populated and begin normal work
|
|
167
|
+
- 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)
|
|
67
168
|
|
|
68
169
|
## Interaction level
|
|
69
170
|
|
|
@@ -83,21 +184,28 @@ tier: full
|
|
|
83
184
|
|
|
84
185
|
method_version: 1.5
|
|
85
186
|
<!-- Tracks which methodology version generated this entry point -->
|
|
86
|
-
<!-- Use `
|
|
187
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
87
188
|
|
|
88
189
|
## CLI tools (optional)
|
|
89
190
|
|
|
90
|
-
|
|
191
|
+
Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
|
|
91
192
|
|
|
92
193
|
| When you want to... | Run |
|
|
93
194
|
|---------------------|-----|
|
|
94
|
-
| Validate this entry point | `
|
|
95
|
-
| See what type of project this is | `
|
|
96
|
-
| Test how a query routes | `
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
195
|
+
| Validate this entry point | `wwa check` |
|
|
196
|
+
| See what type of project this is | `wwa scan` |
|
|
197
|
+
| Test how a query routes | `wwa route "your question"` |
|
|
198
|
+
| See current plan status | `wwa plan` |
|
|
199
|
+
| Get implementation guidance | `wwa implement` |
|
|
200
|
+
| View project review dashboard | `wwa review` |
|
|
201
|
+
| Show management digest | `wwa digest` |
|
|
202
|
+
| Session close + project snapshot | `wwa close` |
|
|
203
|
+
| Extract a refinement report | `wwa refine` |
|
|
204
|
+
| Extract a case study (with project tokens) | `wwa casestudy` |
|
|
205
|
+
| Check docs coverage | `wwa docs` |
|
|
206
|
+
| Check methodology version | `wwa status` |
|
|
207
|
+
| Update methodology files | `wwa upgrade` |
|
|
208
|
+
| Set up a new project | `wwa init code` / `context` / `data` / `mix` |
|
|
101
209
|
|
|
102
210
|
<!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
|
|
103
211
|
project setup, or methodology updates. All commands auto-detect project type and find
|
|
@@ -112,7 +220,8 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
|
|
|
112
220
|
- Surface uncertainty as open questions in STATE.md — never guess silently
|
|
113
221
|
- Keep intelligence layer files under 300 lines — split into index + components subdirectory when exceeded
|
|
114
222
|
- Propose plans and wait for approval — the human controls direction
|
|
115
|
-
-
|
|
223
|
+
- Document proportionally — low-effort tasks (status checks, lookups, clarifications) need no STATE.md or SESSION-LOG updates; high-effort tasks get full recording
|
|
224
|
+
- SUMMARY.md is the session audit trail (date, plan, outcome, files, decisions, next). Management digest lives in Management/DIGEST.md
|
|
116
225
|
- 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
|
|
117
226
|
|
|
118
227
|
## Do not
|
|
@@ -124,5 +233,6 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
|
|
|
124
233
|
- Skip cascade checks after file changes
|
|
125
234
|
- Load multiple specialist .context/ files for a single query
|
|
126
235
|
- Update docs/ for typo fixes or internal-only changes
|
|
236
|
+
- Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
|
|
127
237
|
|
|
128
238
|
<!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
|
package/templates/full/CLAUDE.md
CHANGED
|
@@ -22,6 +22,10 @@
|
|
|
22
22
|
| **Methodology guidance** | .context/METHODOLOGY.md | -- |
|
|
23
23
|
| **Phase completion** | SUMMARY.md | SUMMARY.md, STATE.md, ROADMAP.md |
|
|
24
24
|
| **Backlog / ideas** | todos/backlog.md | todos/backlog.md |
|
|
25
|
+
| **Management overview** | Management/DIGEST.md, Management/STATUS.md, STATE.md | Management/STATUS.md, Management/DIGEST.md |
|
|
26
|
+
| **Project review** | Reviews/INDEX.md, relevant source files | Reviews/ (affected review file) |
|
|
27
|
+
| **Workflow analysis** | agentWorkflows/INDEX.md, SESSION-LOG.md | agentWorkflows/ (affected analysis file) |
|
|
28
|
+
| **Docs update** | .context/DOCS-MAP.md, relevant docs/ files | docs/ files, .context/DOCS-MAP.md |
|
|
25
29
|
|
|
26
30
|
<!-- INSTRUCTION: Replace the {your-domain-type} row with project-specific query types.
|
|
27
31
|
Each should pair .context/BASE.md with one specialist. Add as many rows as needed. -->
|
|
@@ -41,20 +45,24 @@ When a file changes, check this table and update dependent files in the same res
|
|
|
41
45
|
| File split, created, deleted, or renamed | .context/REGISTRY.md (file tree, topic index, structural log) |
|
|
42
46
|
| New domain area | .context/BASE.md, consider new .context/ specialist, this file (if new scoping row) |
|
|
43
47
|
| Lifecycle stage change | PROJECT-PROFILE.md (update stage + date), STATE.md (record decision) |
|
|
44
|
-
| 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) |
|
|
48
|
+
| 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) |
|
|
49
|
+
| Significant milestone or phase completion | Management/STATUS.md (update current state, recent decisions, health indicators) |
|
|
50
|
+
| New project component or module | .context/DOCS-MAP.md (add component mapping, check scaffolding rules for new docs/ proposals) |
|
|
51
|
+
| docs/ file created or deleted | .context/DOCS-MAP.md (update inventory), docs/index.md (update navigation — create if it doesn't exist yet) |
|
|
45
52
|
|
|
46
53
|
<!-- INSTRUCTION: Add project-specific cascade rules below the universal ones above. -->
|
|
47
54
|
|
|
48
55
|
## Docs maintenance
|
|
49
56
|
|
|
50
57
|
<!-- INSTRUCTION: This table tells the agent when to update human-facing docs.
|
|
51
|
-
|
|
58
|
+
For full component-to-docs mapping, see .context/DOCS-MAP.md. -->
|
|
52
59
|
|
|
53
60
|
| Trigger | Update these docs/ files |
|
|
54
61
|
|---------|------------------------|
|
|
55
|
-
| Phase completed | docs/index.md (progress section) |
|
|
56
|
-
| Architecture decision | docs/index.md (architecture section) |
|
|
57
|
-
|
|
|
62
|
+
| Phase completed | docs/index.md (progress section — create from DOCS-MAP.md if it doesn't exist yet) |
|
|
63
|
+
| Architecture decision | docs/index.md (architecture section), .context/DOCS-MAP.md (if new component) |
|
|
64
|
+
| New project component | .context/DOCS-MAP.md (add mapping), docs/ (per DOCS-MAP.md scaffolding rules) |
|
|
65
|
+
| {structural-change} | {specific docs/ files per DOCS-MAP.md component mapping} |
|
|
58
66
|
|
|
59
67
|
## Workflow
|
|
60
68
|
|
|
@@ -62,8 +70,101 @@ Select based on query type:
|
|
|
62
70
|
- **General task** — Review, Plan, Implement, Document, Update
|
|
63
71
|
- **Code change** — Review, Plan, Implement, Context-sync, Update
|
|
64
72
|
- **Context refresh** — Scan, Compare, Update-context, Cascade, Record
|
|
65
|
-
- **First session** —
|
|
66
|
-
- **
|
|
73
|
+
- **First session (greenfield)** — Ask, Populate, Confirm (see onboarding protocol below)
|
|
74
|
+
- **First session (brownfield)** — Scan, Ask, Confirm (see onboarding protocol below)
|
|
75
|
+
|
|
76
|
+
## First session protocol
|
|
77
|
+
|
|
78
|
+
<!-- AGENT: Follow this protocol on the FIRST session when methodology files contain only template placeholders. -->
|
|
79
|
+
|
|
80
|
+
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.
|
|
81
|
+
|
|
82
|
+
### Greenfield onboarding (no existing codebase)
|
|
83
|
+
|
|
84
|
+
**Stage 1 — Project vision** → populates PROJECT.md
|
|
85
|
+
Ask the user:
|
|
86
|
+
1. What is your project about? (1-2 sentences)
|
|
87
|
+
2. Who is it for?
|
|
88
|
+
3. What problem does it solve?
|
|
89
|
+
4. What technologies, languages, or frameworks will you use?
|
|
90
|
+
5. What are 2-3 guiding principles for this project?
|
|
91
|
+
|
|
92
|
+
CHECKPOINT: Draft PROJECT.md from the answers. Show the user the draft. Wait for approval before writing.
|
|
93
|
+
|
|
94
|
+
**Stage 2 — Architecture** → populates .context/BASE.md, PROJECT-PROFILE.md, .context/DOCS-MAP.md
|
|
95
|
+
Ask the user:
|
|
96
|
+
1. What are the main components or modules?
|
|
97
|
+
2. How do they connect? (data flow, API calls, event-driven, etc.)
|
|
98
|
+
3. What is the directory structure? (or what will it be?)
|
|
99
|
+
4. What are the key dependencies?
|
|
100
|
+
|
|
101
|
+
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.
|
|
102
|
+
|
|
103
|
+
**Stage 3 — Goals** → populates ROADMAP.md, PLAN.md
|
|
104
|
+
Ask the user:
|
|
105
|
+
1. What are your immediate goals? (next 1-3 sessions)
|
|
106
|
+
2. What does "done" look like for this project?
|
|
107
|
+
3. Can you break this into 2-4 phases?
|
|
108
|
+
|
|
109
|
+
CHECKPOINT: Draft ROADMAP.md and PLAN.md (first task). Show the user. Wait for approval.
|
|
110
|
+
|
|
111
|
+
**Stage 4 — Starting state** → populates STATE.md
|
|
112
|
+
Ask the user:
|
|
113
|
+
1. Any decisions already made? (tech choices, architecture, constraints)
|
|
114
|
+
2. Any known blockers or risks?
|
|
115
|
+
3. Any open questions you want tracked?
|
|
116
|
+
|
|
117
|
+
CHECKPOINT: Draft STATE.md. Show the user. Wait for approval. Then begin normal work.
|
|
118
|
+
|
|
119
|
+
### Brownfield onboarding (existing codebase)
|
|
120
|
+
|
|
121
|
+
**Stage 1 — Scan** → reads existing files, writes nothing
|
|
122
|
+
Read: package.json, README, directory structure, key config files, entry points.
|
|
123
|
+
Present findings: "Here's what I found in your project: [summary]. Is this accurate?"
|
|
124
|
+
|
|
125
|
+
CHECKPOINT: Wait for user to confirm or correct your understanding.
|
|
126
|
+
|
|
127
|
+
**Stage 2 — Clarify** → populates PROJECT.md, PROJECT-PROFILE.md
|
|
128
|
+
Ask targeted questions based on what the scan missed:
|
|
129
|
+
1. What's the intent behind [pattern you found]?
|
|
130
|
+
2. Are there conventions not captured in config? (naming, structure, etc.)
|
|
131
|
+
3. What's the current state — active development, maintenance, exploration?
|
|
132
|
+
|
|
133
|
+
CHECKPOINT: Draft PROJECT.md from scan + answers. Show the user. Wait for approval.
|
|
134
|
+
|
|
135
|
+
**Stage 3 — Map** → populates .context/BASE.md, .context/DOCS-MAP.md
|
|
136
|
+
Build codebase map from scan. Ask:
|
|
137
|
+
1. Are there areas of the codebase I should understand deeply vs. ignore?
|
|
138
|
+
2. Any architectural decisions I should know about that aren't documented?
|
|
139
|
+
3. What are the most common types of changes you make?
|
|
140
|
+
|
|
141
|
+
CHECKPOINT: Draft .context/BASE.md and .context/DOCS-MAP.md (component-to-docs mapping from scan results). Show the user. Wait for approval.
|
|
142
|
+
|
|
143
|
+
**Stage 4 — Organize** → proposes entry point customization
|
|
144
|
+
Based on understanding, propose:
|
|
145
|
+
1. Scoping rules — which query types match this project?
|
|
146
|
+
2. Specialist context files — which domains need their own .context/ file?
|
|
147
|
+
3. Cascade rules — what project-specific dependencies exist?
|
|
148
|
+
|
|
149
|
+
CHECKPOINT: Show proposed entry point customizations. Wait for approval before modifying this file.
|
|
150
|
+
|
|
151
|
+
**Stage 5 — Starting state** → populates STATE.md, ROADMAP.md
|
|
152
|
+
Propose initial state based on everything learned:
|
|
153
|
+
1. Decisions already implicit in the codebase (document them)
|
|
154
|
+
2. Current position (where is the project in its lifecycle?)
|
|
155
|
+
3. Immediate goals
|
|
156
|
+
|
|
157
|
+
CHECKPOINT: Draft STATE.md and ROADMAP.md. Show the user. Wait for approval. Then begin normal work.
|
|
158
|
+
|
|
159
|
+
### Checkpoint rules
|
|
160
|
+
|
|
161
|
+
- NEVER write to a methodology file without showing the user what you will write first
|
|
162
|
+
- At each CHECKPOINT, present the draft as a code block the user can review
|
|
163
|
+
- If the user says "looks good" or similar, write the file
|
|
164
|
+
- If the user edits or corrects, incorporate changes and show the updated draft
|
|
165
|
+
- If the user says "skip", leave the file as template placeholder
|
|
166
|
+
- After all stages complete, summarize what was populated and begin normal work
|
|
167
|
+
- 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)
|
|
67
168
|
|
|
68
169
|
## Interaction level
|
|
69
170
|
|
|
@@ -83,21 +184,28 @@ tier: full
|
|
|
83
184
|
|
|
84
185
|
method_version: 1.5
|
|
85
186
|
<!-- Tracks which methodology version generated this entry point -->
|
|
86
|
-
<!-- Use `
|
|
187
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
87
188
|
|
|
88
189
|
## CLI tools (optional)
|
|
89
190
|
|
|
90
|
-
|
|
191
|
+
Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
|
|
91
192
|
|
|
92
193
|
| When you want to... | Run |
|
|
93
194
|
|---------------------|-----|
|
|
94
|
-
| Validate this entry point | `
|
|
95
|
-
| See what type of project this is | `
|
|
96
|
-
| Test how a query routes | `
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
195
|
+
| Validate this entry point | `wwa check` |
|
|
196
|
+
| See what type of project this is | `wwa scan` |
|
|
197
|
+
| Test how a query routes | `wwa route "your question"` |
|
|
198
|
+
| See current plan status | `wwa plan` |
|
|
199
|
+
| Get implementation guidance | `wwa implement` |
|
|
200
|
+
| View project review dashboard | `wwa review` |
|
|
201
|
+
| Show management digest | `wwa digest` |
|
|
202
|
+
| Session close + project snapshot | `wwa close` |
|
|
203
|
+
| Extract a refinement report | `wwa refine` |
|
|
204
|
+
| Extract a case study (with project tokens) | `wwa casestudy` |
|
|
205
|
+
| Check docs coverage | `wwa docs` |
|
|
206
|
+
| Check methodology version | `wwa status` |
|
|
207
|
+
| Update methodology files | `wwa upgrade` |
|
|
208
|
+
| Set up a new project | `wwa init code` / `context` / `data` / `mix` |
|
|
101
209
|
|
|
102
210
|
<!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
|
|
103
211
|
project setup, or methodology updates. All commands auto-detect project type and find
|
|
@@ -112,7 +220,8 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
|
|
|
112
220
|
- Surface uncertainty as open questions in STATE.md — never guess silently
|
|
113
221
|
- Keep intelligence layer files under 300 lines — split into index + components subdirectory when exceeded
|
|
114
222
|
- Propose plans and wait for approval — the human controls direction
|
|
115
|
-
-
|
|
223
|
+
- Document proportionally — low-effort tasks (status checks, lookups, clarifications) need no STATE.md or SESSION-LOG updates; high-effort tasks get full recording
|
|
224
|
+
- SUMMARY.md is the session audit trail (date, plan, outcome, files, decisions, next). Management digest lives in Management/DIGEST.md
|
|
116
225
|
- 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
|
|
117
226
|
|
|
118
227
|
## Do not
|
|
@@ -124,5 +233,6 @@ Available via `npx agent-method` (zero-install) or `pip install wwa-tools`:
|
|
|
124
233
|
- Skip cascade checks after file changes
|
|
125
234
|
- Load multiple specialist .context/ files for a single query
|
|
126
235
|
- Update docs/ for typo fixes or internal-only changes
|
|
236
|
+
- Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
|
|
127
237
|
|
|
128
238
|
<!-- 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} |
|
|
@@ -44,3 +44,37 @@
|
|
|
44
44
|
1. {Principle 1}
|
|
45
45
|
2. {Principle 2}
|
|
46
46
|
3. {Principle 3}
|
|
47
|
+
|
|
48
|
+
## Agent onboarding
|
|
49
|
+
|
|
50
|
+
<!-- AGENT: Use these questions to populate this file during the first session.
|
|
51
|
+
Ask the user each question, draft this file from the answers, and show the
|
|
52
|
+
draft at the Stage 1 checkpoint before writing. Remove this section after
|
|
53
|
+
the file is populated — it's scaffolding, not permanent content. -->
|
|
54
|
+
|
|
55
|
+
### Greenfield (no existing codebase)
|
|
56
|
+
|
|
57
|
+
Ask the user:
|
|
58
|
+
1. What is your project about? (1-2 sentences for the description above)
|
|
59
|
+
2. Who is it for? (populate the Audiences table)
|
|
60
|
+
3. What problem does it solve? (populate the Problem section)
|
|
61
|
+
4. What technologies, languages, or frameworks will you use? (informs Solution + structure)
|
|
62
|
+
5. What are 2-3 guiding principles for this project? (populate Principles)
|
|
63
|
+
6. What is the top-level directory structure? (populate Project structure table)
|
|
64
|
+
|
|
65
|
+
### Brownfield (existing codebase)
|
|
66
|
+
|
|
67
|
+
<!-- AGENT: For brownfield projects, you've already scanned the project at Stage 1.
|
|
68
|
+
Pre-fill as much as possible from scan results. Only ask what you couldn't determine. -->
|
|
69
|
+
|
|
70
|
+
Pre-fill from scan:
|
|
71
|
+
- **Description**: infer from README, package.json description, or top-level docs
|
|
72
|
+
- **Project structure**: build from directory listing — auto-populate the table
|
|
73
|
+
- **Technologies**: extract from package.json, requirements.txt, config files, imports
|
|
74
|
+
|
|
75
|
+
Ask the user only what the scan couldn't determine:
|
|
76
|
+
1. Is this description accurate? (confirm or correct the auto-generated description)
|
|
77
|
+
2. Who is the primary audience? (rarely inferable from code alone)
|
|
78
|
+
3. What problem does this solve from the user's perspective? (intent, not implementation)
|
|
79
|
+
4. What guiding principles drive decisions on this project? (conventions, priorities)
|
|
80
|
+
5. Are there directories I should know about that aren't obvious from the structure? (hidden patterns, legacy areas)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Project Reviews
|
|
2
|
+
|
|
3
|
+
<!-- AGENT: This is the review dashboard — a synthesized view of project intelligence.
|
|
4
|
+
Update the summary table when corresponding source files change significantly.
|
|
5
|
+
Each area links to a dedicated drill-down file for detailed analysis.
|
|
6
|
+
|
|
7
|
+
Source files: ROADMAP.md, PLAN.md, PROJECT.md, REQUIREMENTS.md, STATE.md, todos/backlog.md
|
|
8
|
+
This file stays lean — detail lives in the drill-down files. -->
|
|
9
|
+
|
|
10
|
+
## At a glance
|
|
11
|
+
|
|
12
|
+
| Area | Status | Last updated | Drill-down |
|
|
13
|
+
|------|--------|-------------|------------|
|
|
14
|
+
| Roadmap | {on track / behind / ahead} | {date} | [roadmap.md](roadmap.md) |
|
|
15
|
+
| Plan | {active / blocked / between tasks} | {date} | [plan.md](plan.md) |
|
|
16
|
+
| Project | {healthy / needs attention} | {date} | [project.md](project.md) |
|
|
17
|
+
| Requirements | {N/M covered} | {date} | [requirements.md](requirements.md) |
|
|
18
|
+
| State | {N decisions, N blockers, N open Qs} | {date} | [state.md](state.md) |
|
|
19
|
+
| Backlog | {N items, N categories} | {date} | [backlog.md](backlog.md) |
|
|
20
|
+
|
|
21
|
+
## Key metrics
|
|
22
|
+
|
|
23
|
+
<!-- AGENT: Populate from source files. Update after milestones. -->
|
|
24
|
+
|
|
25
|
+
- **Phases completed**: {N of M}
|
|
26
|
+
- **Requirements covered**: {N of M} ({percentage}%)
|
|
27
|
+
- **Active blockers**: {count}
|
|
28
|
+
- **Open questions**: {count}
|
|
29
|
+
- **Backlog items**: {count}
|
|
30
|
+
- **Decisions recorded**: {count}
|
|
31
|
+
|
|
32
|
+
## Trend indicators
|
|
33
|
+
|
|
34
|
+
<!-- AGENT: Track how metrics change over time. Update after phase completions. -->
|
|
35
|
+
|
|
36
|
+
| Metric | Previous | Current | Trend |
|
|
37
|
+
|--------|----------|---------|-------|
|
|
38
|
+
| Phases completed | {N} | {N} | {↑ / → / ↓} |
|
|
39
|
+
| Requirements coverage | {N}% | {N}% | {↑ / → / ↓} |
|
|
40
|
+
| Open blockers | {N} | {N} | {↑ / → / ↓} |
|
|
41
|
+
| Backlog size | {N} | {N} | {↑ / → / ↓} |
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Backlog Review
|
|
2
|
+
|
|
3
|
+
<!-- AGENT: Synthesize from todos/backlog.md. Track backlog health — item counts,
|
|
4
|
+
categories, aging, completion rates. This helps identify neglected areas
|
|
5
|
+
and prioritization patterns.
|
|
6
|
+
Update after significant backlog changes (new categories, large batch completions).
|
|
7
|
+
|
|
8
|
+
Source: todos/backlog.md
|
|
9
|
+
Parent: Reviews/INDEX.md (update "At a glance" row when this changes) -->
|
|
10
|
+
|
|
11
|
+
## Summary
|
|
12
|
+
|
|
13
|
+
- **Total items**: {count}
|
|
14
|
+
- **Completed**: {count} ({%})
|
|
15
|
+
- **Pending**: {count} ({%})
|
|
16
|
+
|
|
17
|
+
## By category
|
|
18
|
+
|
|
19
|
+
| Category | Total | Done | Pending | Completion |
|
|
20
|
+
|----------|-------|------|---------|------------|
|
|
21
|
+
<!-- Group backlog items by their section headings -->
|
|
22
|
+
|
|
23
|
+
## Aging analysis
|
|
24
|
+
|
|
25
|
+
<!-- AGENT: How long have pending items been in the backlog? Any items that should
|
|
26
|
+
be promoted to the roadmap or removed? -->
|
|
27
|
+
|
|
28
|
+
| Age bracket | Count |
|
|
29
|
+
|-------------|-------|
|
|
30
|
+
| Added this phase | {N} |
|
|
31
|
+
| 1-2 phases old | {N} |
|
|
32
|
+
| 3+ phases old | {N} |
|
|
33
|
+
|
|
34
|
+
### Stale items
|
|
35
|
+
|
|
36
|
+
<!-- Items that have been pending for 3+ phases. Should they be promoted, deferred, or removed? -->
|
|
37
|
+
|
|
38
|
+
## Prioritization patterns
|
|
39
|
+
|
|
40
|
+
<!-- AGENT: What gets completed first? Any categories consistently neglected? -->
|
|
41
|
+
|
|
42
|
+
### Fast-tracked categories
|
|
43
|
+
|
|
44
|
+
<!-- Categories with high completion rates — what gets done quickly? -->
|
|
45
|
+
|
|
46
|
+
### Neglected categories
|
|
47
|
+
|
|
48
|
+
<!-- Categories with low completion rates — what gets deferred repeatedly? -->
|
|
49
|
+
|
|
50
|
+
## Recommendations
|
|
51
|
+
|
|
52
|
+
<!-- AGENT: Based on backlog analysis, what should be prioritized next? -->
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Plan Review
|
|
2
|
+
|
|
3
|
+
<!-- AGENT: Synthesize from PLAN.md. Track plan execution patterns — how well do plans
|
|
4
|
+
match actual outcomes? What patterns emerge in task sizing and completion?
|
|
5
|
+
Update after each plan completes or when plan structure changes.
|
|
6
|
+
|
|
7
|
+
Source: PLAN.md (current), SUMMARY.md (historical)
|
|
8
|
+
Parent: Reviews/INDEX.md (update "At a glance" row when this changes) -->
|
|
9
|
+
|
|
10
|
+
## Current plan status
|
|
11
|
+
|
|
12
|
+
| Field | Value |
|
|
13
|
+
|-------|-------|
|
|
14
|
+
| Plan | {current plan name/phase} |
|
|
15
|
+
| Steps | {completed}/{total} |
|
|
16
|
+
| Status | {in progress / blocked / complete} |
|
|
17
|
+
| Started | {date} |
|
|
18
|
+
|
|
19
|
+
## Execution history
|
|
20
|
+
|
|
21
|
+
<!-- AGENT: Track completed plans. Populate from SUMMARY.md audit trail. -->
|
|
22
|
+
|
|
23
|
+
| Plan | Steps | Outcome | Duration | Revisions |
|
|
24
|
+
|------|-------|---------|----------|-----------|
|
|
25
|
+
<!-- {plan name} | {N steps} | {completed / partial / abandoned} | {time} | {count} -->
|
|
26
|
+
|
|
27
|
+
## Execution patterns
|
|
28
|
+
|
|
29
|
+
<!-- AGENT: What patterns emerge across plan completions? -->
|
|
30
|
+
|
|
31
|
+
### Task sizing accuracy
|
|
32
|
+
|
|
33
|
+
- **Plans completed as designed**: {count} ({%})
|
|
34
|
+
- **Plans that needed scope adjustment**: {count} ({%})
|
|
35
|
+
- **Plans abandoned/rewritten**: {count} ({%})
|
|
36
|
+
|
|
37
|
+
### Common revision triggers
|
|
38
|
+
|
|
39
|
+
<!-- What causes plans to be revised? -->
|
|
40
|
+
|
|
41
|
+
### Step completion patterns
|
|
42
|
+
|
|
43
|
+
<!-- Do certain types of steps take longer or fail more often? -->
|