agent-method 1.5.3 → 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 +197 -57
- 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 +71 -71
- 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 +202 -202
- package/lib/cli/review.js +68 -0
- package/lib/cli/scan.js +28 -28
- package/lib/cli/status.js +61 -61
- package/lib/cli/upgrade.js +150 -147
- package/lib/init.js +478 -296
- package/package.json +12 -4
- package/templates/README.md +73 -25
- package/templates/entry-points/.cursorrules +143 -14
- package/templates/entry-points/AGENT.md +143 -14
- package/templates/entry-points/CLAUDE.md +143 -14
- 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 +128 -18
- package/templates/full/AGENT.md +128 -18
- package/templates/full/CLAUDE.md +128 -18
- 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/SESSION-LOG.md +29 -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 +135 -13
- package/templates/starter/AGENT.md +135 -13
- package/templates/starter/CLAUDE.md +135 -13
- 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/SESSION-LOG.md +29 -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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agent-method",
|
|
3
|
-
"version": "1.5.
|
|
3
|
+
"version": "1.5.6",
|
|
4
4
|
"description": "CLI tools for the wwa methodology — registry-driven routing, validation, and project setup for AI-agent-assisted development",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai-agents",
|
|
@@ -8,19 +8,27 @@
|
|
|
8
8
|
"context-engineering",
|
|
9
9
|
"methodology",
|
|
10
10
|
"developer-tools",
|
|
11
|
-
"cli"
|
|
11
|
+
"cli",
|
|
12
|
+
"claude-code",
|
|
13
|
+
"cursor",
|
|
14
|
+
"gemini",
|
|
15
|
+
"codex",
|
|
16
|
+
"mcp",
|
|
17
|
+
"agent-framework"
|
|
12
18
|
],
|
|
13
19
|
"type": "module",
|
|
14
20
|
"license": "MIT",
|
|
15
21
|
"author": "wwa contributors",
|
|
16
22
|
"bin": {
|
|
17
|
-
"wwa": "bin/wwa.js"
|
|
23
|
+
"wwa": "bin/wwa.js",
|
|
24
|
+
"agent-method": "bin/wwa.js"
|
|
18
25
|
},
|
|
19
26
|
"files": [
|
|
20
27
|
"bin/",
|
|
21
28
|
"lib/",
|
|
22
29
|
"templates/",
|
|
23
|
-
"docs/internal/feature-registry.yaml"
|
|
30
|
+
"docs/internal/feature-registry.yaml",
|
|
31
|
+
"docs/internal/doc-tokens.yaml"
|
|
24
32
|
],
|
|
25
33
|
"main": "lib/registry.js",
|
|
26
34
|
"engines": {
|
package/templates/README.md
CHANGED
|
@@ -4,7 +4,7 @@ Copyable project templates. Pick one, copy it into your project root, fill in PR
|
|
|
4
4
|
|
|
5
5
|
## Starter template (minimum viable)
|
|
6
6
|
|
|
7
|
-
For most projects.
|
|
7
|
+
For most projects. Gives you cross-session memory, scoped context loading, persistent codebase understanding, lifecycle tracking, structured execution, and management reporting.
|
|
8
8
|
|
|
9
9
|
```
|
|
10
10
|
starter/
|
|
@@ -16,15 +16,31 @@ starter/
|
|
|
16
16
|
STATE.md # Decisions, blockers, current position
|
|
17
17
|
ROADMAP.md # Phase breakdown with gate criteria
|
|
18
18
|
PLAN.md # Current task with verification criteria
|
|
19
|
+
SUMMARY.md # Session audit trail
|
|
20
|
+
SESSION-LOG.md # Session metrics for case study data
|
|
19
21
|
.context/
|
|
20
22
|
BASE.md # Core context -- always loaded with entry point
|
|
23
|
+
METHODOLOGY.md # Methodology overflow for lite/standard profiles
|
|
24
|
+
feature-registry.yaml # Feature registry (copied from package at init)
|
|
25
|
+
doc-tokens.yaml # Project metrics (created at init, updated by wwa close)
|
|
26
|
+
Management/
|
|
27
|
+
DIGEST.md # High-effort task digest for managers
|
|
28
|
+
STATUS.md # Project health snapshot
|
|
29
|
+
Reviews/
|
|
30
|
+
INDEX.md # Synthesized project intelligence dashboard
|
|
31
|
+
agentWorkflows/
|
|
32
|
+
INDEX.md # Agent workflow performance overview
|
|
33
|
+
intro/
|
|
34
|
+
README.md # Methodology overview + link to full docs
|
|
21
35
|
```
|
|
22
36
|
|
|
23
37
|
**Setup**: Delete the two entry point files you don't use. Keep the one that matches your agent runtime.
|
|
24
38
|
|
|
25
|
-
**What you get**: Persistent decisions, scoped file reading, phase-gated execution, atomic task tracking, configurable interaction level, persistent codebase context.
|
|
39
|
+
**What you get**: Persistent decisions, scoped file reading, phase-gated execution, atomic task tracking, configurable interaction level, persistent codebase context, management digest, project reviews, workflow analysis, docs dependency mapping.
|
|
26
40
|
|
|
27
|
-
**
|
|
41
|
+
**docs/ is for your project**: The `docs/` folder is not pre-created — the agent creates `.context/DOCS-MAP.md` during first-session onboarding and proposes docs/ files as your project grows based on its scaffolding rules.
|
|
42
|
+
|
|
43
|
+
**What you don't get**: Specialist context pairing, full review drill-downs, full workflow analysis files.
|
|
28
44
|
|
|
29
45
|
## Full template (complete methodology)
|
|
30
46
|
|
|
@@ -32,27 +48,49 @@ For complex or multi-phase projects where context management and dual-audience s
|
|
|
32
48
|
|
|
33
49
|
```
|
|
34
50
|
full/
|
|
35
|
-
CLAUDE.md
|
|
36
|
-
.cursorrules
|
|
37
|
-
AGENT.md
|
|
51
|
+
CLAUDE.md # Claude Code entry point (auto-loaded)
|
|
52
|
+
.cursorrules # Cursor entry point (auto-loaded)
|
|
53
|
+
AGENT.md # Generic entry point (manual loading)
|
|
38
54
|
PROJECT.md # Vision, audiences, structure
|
|
39
55
|
PROJECT-PROFILE.md # Project type, lifecycle, extensions (agent-maintained)
|
|
40
56
|
STATE.md # Decisions, blockers, position, open questions
|
|
41
57
|
REQUIREMENTS.md # Scoped features with phase traceability
|
|
42
|
-
ROADMAP.md
|
|
43
|
-
PLAN.md
|
|
44
|
-
SUMMARY.md
|
|
58
|
+
ROADMAP.md # Phase breakdown with gate criteria
|
|
59
|
+
PLAN.md # Current atomic task
|
|
60
|
+
SUMMARY.md # Session audit trail
|
|
61
|
+
SESSION-LOG.md # Session metrics for case study data
|
|
45
62
|
.context/
|
|
46
|
-
BASE.md
|
|
47
|
-
|
|
48
|
-
|
|
63
|
+
BASE.md # Core context -- always loaded with entry point
|
|
64
|
+
METHODOLOGY.md # Methodology overflow for lite/standard profiles
|
|
65
|
+
REGISTRY.md # Navigation registry for split file trees
|
|
66
|
+
COMPOSITION.md # Specialist template for analytical projects
|
|
67
|
+
feature-registry.yaml # Feature registry (copied from package at init)
|
|
68
|
+
doc-tokens.yaml # Project metrics (created at init, updated by wwa close)
|
|
69
|
+
Management/
|
|
70
|
+
DIGEST.md # High-effort task digest for managers
|
|
71
|
+
STATUS.md # Project health snapshot
|
|
72
|
+
Reviews/
|
|
73
|
+
INDEX.md # Synthesized project intelligence dashboard
|
|
74
|
+
roadmap.md # Phase progress synthesis
|
|
75
|
+
plan.md # Plan execution history
|
|
76
|
+
project.md # Project scope evolution
|
|
77
|
+
requirements.md # Requirements traceability matrix
|
|
78
|
+
state.md # Decision trends and blocker analysis
|
|
79
|
+
backlog.md # Backlog health and aging
|
|
80
|
+
agentWorkflows/
|
|
81
|
+
INDEX.md # Agent workflow performance overview
|
|
82
|
+
sessions.md # Session analysis from SESSION-LOG.md
|
|
83
|
+
patterns.md # Extracted behavioral patterns
|
|
84
|
+
observations.md # Case study observations
|
|
85
|
+
intro/
|
|
86
|
+
README.md # Methodology overview + link to full docs
|
|
49
87
|
todos/
|
|
50
|
-
backlog.md
|
|
88
|
+
backlog.md # Captured ideas for future work
|
|
51
89
|
```
|
|
52
90
|
|
|
53
91
|
**Setup**: Delete the two entry point files you don't use. Keep the one that matches your agent runtime.
|
|
54
92
|
|
|
55
|
-
**What you get**: Everything in starter, plus specialist context pairing, dependency cascade, execution history, human dashboard scaffold, backlog capture, full communication point structure (direction, checkpoint, record).
|
|
93
|
+
**What you get**: Everything in starter, plus specialist context pairing, dependency cascade, execution history, human dashboard scaffold, backlog capture, full review drill-downs, full workflow analysis, full communication point structure (direction, checkpoint, record).
|
|
56
94
|
|
|
57
95
|
## Template content: guided, not empty
|
|
58
96
|
|
|
@@ -229,7 +267,7 @@ See `docs/architecture/context-pairing.md` for the full context maintenance life
|
|
|
229
267
|
### Recommended: npx
|
|
230
268
|
|
|
231
269
|
```bash
|
|
232
|
-
npx
|
|
270
|
+
npx agent-method init code ~/my-project
|
|
233
271
|
```
|
|
234
272
|
|
|
235
273
|
Replace `code` with: `context`, `data`, `mix`, or `general`.
|
|
@@ -249,8 +287,8 @@ See `docs/guides/quick-start.md` for a detailed walkthrough.
|
|
|
249
287
|
The methodology works without any tooling. For teams that want additional validation and automation:
|
|
250
288
|
|
|
251
289
|
```bash
|
|
252
|
-
npx
|
|
253
|
-
npm install -g
|
|
290
|
+
npx agent-method # zero-install (Node.js 18+)
|
|
291
|
+
npm install -g agent-method # permanent install
|
|
254
292
|
pip install wwa-tools # Python alternative
|
|
255
293
|
```
|
|
256
294
|
|
|
@@ -258,13 +296,23 @@ pip install wwa-tools # Python alternative
|
|
|
258
296
|
|
|
259
297
|
| Command | Use case |
|
|
260
298
|
|---------|----------|
|
|
261
|
-
| `
|
|
262
|
-
| `
|
|
263
|
-
| `
|
|
264
|
-
| `
|
|
265
|
-
| `
|
|
266
|
-
| `
|
|
267
|
-
| `
|
|
299
|
+
| `wwa check` | Validate entry point (auto-finds CLAUDE.md/.cursorrules/AGENT.md) |
|
|
300
|
+
| `wwa scan` | Detect project type from directory contents |
|
|
301
|
+
| `wwa route "<query>"` | Test how a query routes through the pipeline |
|
|
302
|
+
| `wwa plan` | Display current plan status from PLAN.md |
|
|
303
|
+
| `wwa implement` | Show implementation guidance for current step |
|
|
304
|
+
| `wwa review` | Display project review dashboard |
|
|
305
|
+
| `wwa digest` | Show management digest |
|
|
306
|
+
| `wwa close` | Session close checklist, project snapshot, updates .context/doc-tokens.yaml |
|
|
307
|
+
| `wwa refine` | Extract refinement report (auto-finds SESSION-LOG.md) |
|
|
308
|
+
| `wwa casestudy` | Extract case study with project tokens + methodology reference data |
|
|
309
|
+
| `wwa docs` | Show docs coverage report from DOCS-MAP.md |
|
|
310
|
+
| `wwa status` | Check if methodology version is current |
|
|
311
|
+
| `wwa upgrade` | Brownfield-safe update (adds missing files, updates version) |
|
|
312
|
+
| `wwa init <type>` | Set up a new project |
|
|
313
|
+
| `wwa completion` | Generate shell tab-completion (bash/zsh/fish/PowerShell) |
|
|
314
|
+
|
|
315
|
+
**Safety invariant**: The CLI tool never modifies user source code. Only `.md` and `.yaml`/`.yml` files are writable.
|
|
268
316
|
|
|
269
317
|
### Project types
|
|
270
318
|
|
|
@@ -279,7 +327,7 @@ wwa init mix # multi-type project
|
|
|
279
327
|
|
|
280
328
|
### Advanced: pipeline subcommands
|
|
281
329
|
|
|
282
|
-
For debugging routing logic: `
|
|
330
|
+
For debugging routing logic: `wwa pipeline classify|select|resolve|cascade|test`.
|
|
283
331
|
|
|
284
332
|
### Dependencies
|
|
285
333
|
|
|
@@ -7,7 +7,8 @@
|
|
|
7
7
|
|
|
8
8
|
1. This file is auto-loaded — read it first
|
|
9
9
|
2. Read `STATE.md` for current position, decisions, blockers
|
|
10
|
-
3.
|
|
10
|
+
3. Check `PROJECT-PROFILE.md` for lifecycle stage and active extensions
|
|
11
|
+
4. Scope based on query type (see table below)
|
|
11
12
|
|
|
12
13
|
## Scoping rules
|
|
13
14
|
|
|
@@ -15,10 +16,16 @@
|
|
|
15
16
|
|------------|-------------------|-------------------|
|
|
16
17
|
| **Planning / roadmap** | REQUIREMENTS.md, ROADMAP.md | STATE.md, PLAN.md |
|
|
17
18
|
| **Context refresh** | .context/ (all), project structure | .context/, this file (if scoping rules affected) |
|
|
19
|
+
| **Project discovery** | Project structure, package files, key source files | .context/BASE.md, .context/ specialists, STATE.md |
|
|
18
20
|
| **{your-domain-type}** | .context/BASE.md + .context/{SPECIALIST}.md | {affected working files} |
|
|
21
|
+
| **Structural navigation** | .context/REGISTRY.md | .context/REGISTRY.md (if structure changed) |
|
|
19
22
|
| **Methodology guidance** | .context/METHODOLOGY.md | -- |
|
|
20
23
|
| **Phase completion** | SUMMARY.md | SUMMARY.md, STATE.md, ROADMAP.md |
|
|
21
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 |
|
|
22
29
|
|
|
23
30
|
<!-- INSTRUCTION: Replace the {your-domain-type} row with project-specific query types.
|
|
24
31
|
Each should pair .context/BASE.md with one specialist. Add as many rows as needed. -->
|
|
@@ -35,18 +42,129 @@ When a file changes, check this table and update dependent files in the same res
|
|
|
35
42
|
| Open question resolved | STATE.md (mark resolved with resolution text, don't delete) |
|
|
36
43
|
| Project structure | .context/BASE.md (codebase map), this file (if new query types needed) |
|
|
37
44
|
| Intelligence layer file exceeds 300 lines | Restructure into index + components subdirectory (keep active content, archive completed sections) |
|
|
45
|
+
| File split, created, deleted, or renamed | .context/REGISTRY.md (file tree, topic index, structural log) |
|
|
38
46
|
| New domain area | .context/BASE.md, consider new .context/ specialist, this file (if new scoping row) |
|
|
39
|
-
|
|
|
47
|
+
| Lifecycle stage change | PROJECT-PROFILE.md (update stage + date), STATE.md (record decision) |
|
|
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) |
|
|
40
52
|
|
|
41
53
|
<!-- INSTRUCTION: Add project-specific cascade rules below the universal ones above. -->
|
|
42
54
|
|
|
55
|
+
## Docs maintenance
|
|
56
|
+
|
|
57
|
+
<!-- INSTRUCTION: This table tells the agent when to update human-facing docs.
|
|
58
|
+
For full component-to-docs mapping, see .context/DOCS-MAP.md. -->
|
|
59
|
+
|
|
60
|
+
| Trigger | Update these docs/ files |
|
|
61
|
+
|---------|------------------------|
|
|
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} |
|
|
66
|
+
|
|
43
67
|
## Workflow
|
|
44
68
|
|
|
45
69
|
Select based on query type:
|
|
46
70
|
- **General task** — Review, Plan, Implement, Document, Update
|
|
47
71
|
- **Code change** — Review, Plan, Implement, Context-sync, Update
|
|
48
72
|
- **Context refresh** — Scan, Compare, Update-context, Cascade, Record
|
|
49
|
-
- **First session** —
|
|
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)
|
|
50
168
|
|
|
51
169
|
## Interaction level
|
|
52
170
|
|
|
@@ -56,7 +174,7 @@ mode: checkpoint
|
|
|
56
174
|
|
|
57
175
|
## Model tier
|
|
58
176
|
|
|
59
|
-
tier:
|
|
177
|
+
tier: full
|
|
60
178
|
<!-- lite | standard | full -->
|
|
61
179
|
<!-- lite: minimal rules, STATE.md only, 2 cascade rules — for Haiku or simple projects -->
|
|
62
180
|
<!-- standard: core rules + context pairing, overflow to .context/METHODOLOGY.md — for Sonnet (default) -->
|
|
@@ -66,21 +184,28 @@ tier: standard
|
|
|
66
184
|
|
|
67
185
|
method_version: 1.5
|
|
68
186
|
<!-- Tracks which methodology version generated this entry point -->
|
|
69
|
-
<!-- Use `
|
|
187
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
70
188
|
|
|
71
189
|
## CLI tools (optional)
|
|
72
190
|
|
|
73
|
-
|
|
191
|
+
Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
|
|
74
192
|
|
|
75
193
|
| When you want to... | Run |
|
|
76
194
|
|---------------------|-----|
|
|
77
|
-
| Validate this entry point | `
|
|
78
|
-
| See what type of project this is | `
|
|
79
|
-
| Test how a query routes | `
|
|
80
|
-
|
|
|
81
|
-
|
|
|
82
|
-
|
|
|
83
|
-
|
|
|
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` |
|
|
84
209
|
|
|
85
210
|
<!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
|
|
86
211
|
project setup, or methodology updates. All commands auto-detect project type and find
|
|
@@ -95,7 +220,9 @@ Available via `npx wwa` (zero-install) or `pip install wwa-tools`:
|
|
|
95
220
|
- Surface uncertainty as open questions in STATE.md — never guess silently
|
|
96
221
|
- Keep intelligence layer files under 300 lines — split into index + components subdirectory when exceeded
|
|
97
222
|
- Propose plans and wait for approval — the human controls direction
|
|
98
|
-
-
|
|
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
|
|
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
|
|
99
226
|
|
|
100
227
|
## Do not
|
|
101
228
|
|
|
@@ -105,5 +232,7 @@ Available via `npx wwa` (zero-install) or `pip install wwa-tools`:
|
|
|
105
232
|
- Defer STATE.md decision recording to end of session
|
|
106
233
|
- Skip cascade checks after file changes
|
|
107
234
|
- Load multiple specialist .context/ files for a single query
|
|
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
|
|
108
237
|
|
|
109
238
|
<!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
|
|
@@ -7,7 +7,8 @@
|
|
|
7
7
|
|
|
8
8
|
1. This file is auto-loaded — read it first
|
|
9
9
|
2. Read `STATE.md` for current position, decisions, blockers
|
|
10
|
-
3.
|
|
10
|
+
3. Check `PROJECT-PROFILE.md` for lifecycle stage and active extensions
|
|
11
|
+
4. Scope based on query type (see table below)
|
|
11
12
|
|
|
12
13
|
## Scoping rules
|
|
13
14
|
|
|
@@ -15,10 +16,16 @@
|
|
|
15
16
|
|------------|-------------------|-------------------|
|
|
16
17
|
| **Planning / roadmap** | REQUIREMENTS.md, ROADMAP.md | STATE.md, PLAN.md |
|
|
17
18
|
| **Context refresh** | .context/ (all), project structure | .context/, this file (if scoping rules affected) |
|
|
19
|
+
| **Project discovery** | Project structure, package files, key source files | .context/BASE.md, .context/ specialists, STATE.md |
|
|
18
20
|
| **{your-domain-type}** | .context/BASE.md + .context/{SPECIALIST}.md | {affected working files} |
|
|
21
|
+
| **Structural navigation** | .context/REGISTRY.md | .context/REGISTRY.md (if structure changed) |
|
|
19
22
|
| **Methodology guidance** | .context/METHODOLOGY.md | -- |
|
|
20
23
|
| **Phase completion** | SUMMARY.md | SUMMARY.md, STATE.md, ROADMAP.md |
|
|
21
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 |
|
|
22
29
|
|
|
23
30
|
<!-- INSTRUCTION: Replace the {your-domain-type} row with project-specific query types.
|
|
24
31
|
Each should pair .context/BASE.md with one specialist. Add as many rows as needed. -->
|
|
@@ -35,18 +42,129 @@ When a file changes, check this table and update dependent files in the same res
|
|
|
35
42
|
| Open question resolved | STATE.md (mark resolved with resolution text, don't delete) |
|
|
36
43
|
| Project structure | .context/BASE.md (codebase map), this file (if new query types needed) |
|
|
37
44
|
| Intelligence layer file exceeds 300 lines | Restructure into index + components subdirectory (keep active content, archive completed sections) |
|
|
45
|
+
| File split, created, deleted, or renamed | .context/REGISTRY.md (file tree, topic index, structural log) |
|
|
38
46
|
| New domain area | .context/BASE.md, consider new .context/ specialist, this file (if new scoping row) |
|
|
39
|
-
|
|
|
47
|
+
| Lifecycle stage change | PROJECT-PROFILE.md (update stage + date), STATE.md (record decision) |
|
|
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) |
|
|
40
52
|
|
|
41
53
|
<!-- INSTRUCTION: Add project-specific cascade rules below the universal ones above. -->
|
|
42
54
|
|
|
55
|
+
## Docs maintenance
|
|
56
|
+
|
|
57
|
+
<!-- INSTRUCTION: This table tells the agent when to update human-facing docs.
|
|
58
|
+
For full component-to-docs mapping, see .context/DOCS-MAP.md. -->
|
|
59
|
+
|
|
60
|
+
| Trigger | Update these docs/ files |
|
|
61
|
+
|---------|------------------------|
|
|
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} |
|
|
66
|
+
|
|
43
67
|
## Workflow
|
|
44
68
|
|
|
45
69
|
Select based on query type:
|
|
46
70
|
- **General task** — Review, Plan, Implement, Document, Update
|
|
47
71
|
- **Code change** — Review, Plan, Implement, Context-sync, Update
|
|
48
72
|
- **Context refresh** — Scan, Compare, Update-context, Cascade, Record
|
|
49
|
-
- **First session** —
|
|
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)
|
|
50
168
|
|
|
51
169
|
## Interaction level
|
|
52
170
|
|
|
@@ -56,7 +174,7 @@ mode: checkpoint
|
|
|
56
174
|
|
|
57
175
|
## Model tier
|
|
58
176
|
|
|
59
|
-
tier:
|
|
177
|
+
tier: full
|
|
60
178
|
<!-- lite | standard | full -->
|
|
61
179
|
<!-- lite: minimal rules, STATE.md only, 2 cascade rules — for Haiku or simple projects -->
|
|
62
180
|
<!-- standard: core rules + context pairing, overflow to .context/METHODOLOGY.md — for Sonnet (default) -->
|
|
@@ -66,21 +184,28 @@ tier: standard
|
|
|
66
184
|
|
|
67
185
|
method_version: 1.5
|
|
68
186
|
<!-- Tracks which methodology version generated this entry point -->
|
|
69
|
-
<!-- Use `
|
|
187
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
70
188
|
|
|
71
189
|
## CLI tools (optional)
|
|
72
190
|
|
|
73
|
-
|
|
191
|
+
Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
|
|
74
192
|
|
|
75
193
|
| When you want to... | Run |
|
|
76
194
|
|---------------------|-----|
|
|
77
|
-
| Validate this entry point | `
|
|
78
|
-
| See what type of project this is | `
|
|
79
|
-
| Test how a query routes | `
|
|
80
|
-
|
|
|
81
|
-
|
|
|
82
|
-
|
|
|
83
|
-
|
|
|
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` |
|
|
84
209
|
|
|
85
210
|
<!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
|
|
86
211
|
project setup, or methodology updates. All commands auto-detect project type and find
|
|
@@ -95,7 +220,9 @@ Available via `npx wwa` (zero-install) or `pip install wwa-tools`:
|
|
|
95
220
|
- Surface uncertainty as open questions in STATE.md — never guess silently
|
|
96
221
|
- Keep intelligence layer files under 300 lines — split into index + components subdirectory when exceeded
|
|
97
222
|
- Propose plans and wait for approval — the human controls direction
|
|
98
|
-
-
|
|
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
|
|
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
|
|
99
226
|
|
|
100
227
|
## Do not
|
|
101
228
|
|
|
@@ -105,5 +232,7 @@ Available via `npx wwa` (zero-install) or `pip install wwa-tools`:
|
|
|
105
232
|
- Defer STATE.md decision recording to end of session
|
|
106
233
|
- Skip cascade checks after file changes
|
|
107
234
|
- Load multiple specialist .context/ files for a single query
|
|
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
|
|
108
237
|
|
|
109
238
|
<!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
|