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.
Potentially problematic release.
This version of agent-method might be problematic. Click here for more details.
- 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
|
@@ -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, 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** —
|
|
53
|
-
- **
|
|
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 `
|
|
185
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
74
186
|
|
|
75
187
|
## CLI tools (optional)
|
|
76
188
|
|
|
77
|
-
|
|
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 | `
|
|
82
|
-
| See what type of project this is | `
|
|
83
|
-
| Test how a query routes | `
|
|
84
|
-
|
|
|
85
|
-
|
|
|
86
|
-
|
|
|
87
|
-
|
|
|
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,7 +218,9 @@ Available via `npx wwa` (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
|
|
102
|
-
-
|
|
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
|
|
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
|
|
105
226
|
|
|
@@ -109,5 +230,6 @@ Available via `npx wwa` (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} |
|
|
@@ -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,75 @@
|
|
|
1
|
+
# Project Reviews
|
|
2
|
+
|
|
3
|
+
<!-- AGENT: This is the review dashboard — a synthesized view of project intelligence.
|
|
4
|
+
Update sections when the corresponding source file changes significantly.
|
|
5
|
+
|
|
6
|
+
Source files: ROADMAP.md, PLAN.md, STATE.md, todos/backlog.md
|
|
7
|
+
When this file exceeds 300 lines, split sections into individual files
|
|
8
|
+
in this directory (roadmap.md, plan.md, state.md, backlog.md). -->
|
|
9
|
+
|
|
10
|
+
## At a glance
|
|
11
|
+
|
|
12
|
+
| Area | Status | Last updated |
|
|
13
|
+
|------|--------|-------------|
|
|
14
|
+
| Roadmap | {on track / behind / ahead} | {date} |
|
|
15
|
+
| Plan | {active / blocked / between tasks} | {date} |
|
|
16
|
+
| State | {N decisions, N blockers, N open questions} | {date} |
|
|
17
|
+
| Backlog | {N items} | {date} |
|
|
18
|
+
|
|
19
|
+
## Roadmap review
|
|
20
|
+
|
|
21
|
+
<!-- AGENT: Synthesize from ROADMAP.md. Phase progress, milestone tracking. -->
|
|
22
|
+
|
|
23
|
+
### Phase progress
|
|
24
|
+
|
|
25
|
+
| Phase | Status | Completion |
|
|
26
|
+
|-------|--------|------------|
|
|
27
|
+
<!-- Populate from ROADMAP.md -->
|
|
28
|
+
|
|
29
|
+
### Velocity notes
|
|
30
|
+
|
|
31
|
+
<!-- Brief observations about project velocity and trajectory. -->
|
|
32
|
+
|
|
33
|
+
## Plan review
|
|
34
|
+
|
|
35
|
+
<!-- AGENT: Synthesize from PLAN.md. Current task status, execution patterns. -->
|
|
36
|
+
|
|
37
|
+
### Current task
|
|
38
|
+
|
|
39
|
+
<!-- What's being worked on, how it's progressing. -->
|
|
40
|
+
|
|
41
|
+
### Execution patterns
|
|
42
|
+
|
|
43
|
+
<!-- Observations about plan execution — revision patterns, task sizing accuracy. -->
|
|
44
|
+
|
|
45
|
+
## State review
|
|
46
|
+
|
|
47
|
+
<!-- AGENT: Synthesize from STATE.md. Decision trends, blocker aging, question resolution. -->
|
|
48
|
+
|
|
49
|
+
### Decision summary
|
|
50
|
+
|
|
51
|
+
- **Total decisions**: {count}
|
|
52
|
+
- **Recent decisions** (last 5):
|
|
53
|
+
|
|
54
|
+
<!-- List last 5 decisions from STATE.md -->
|
|
55
|
+
|
|
56
|
+
### Blocker status
|
|
57
|
+
|
|
58
|
+
<!-- Active blockers, how long they've been open, resolution progress. -->
|
|
59
|
+
|
|
60
|
+
### Open questions
|
|
61
|
+
|
|
62
|
+
<!-- Active open questions, aging analysis, resolution rate. -->
|
|
63
|
+
|
|
64
|
+
## Backlog review
|
|
65
|
+
|
|
66
|
+
<!-- AGENT: Synthesize from todos/backlog.md. Item counts, categories, aging. -->
|
|
67
|
+
|
|
68
|
+
### Summary
|
|
69
|
+
|
|
70
|
+
- **Total items**: {count}
|
|
71
|
+
- **Categories**: {list with counts}
|
|
72
|
+
|
|
73
|
+
### Aging
|
|
74
|
+
|
|
75
|
+
<!-- How old are backlog items? Any that need attention? -->
|
|
@@ -40,6 +40,27 @@ Append-only session observation log for case study data collection. Each session
|
|
|
40
40
|
- **high**: Entry point + STATE.md + specialist context + multiple project files
|
|
41
41
|
- **very high**: Extensive project context, multiple specialists, cross-file analysis
|
|
42
42
|
|
|
43
|
+
**User response** (agent-observed — how did the user respond to the result?):
|
|
44
|
+
- **accepted**: User proceeded to next step without changes
|
|
45
|
+
- **edited**: User manually modified the agent's output
|
|
46
|
+
- **revised**: User asked agent to redo or revise the result
|
|
47
|
+
- **rejected**: User said no or declined the result entirely
|
|
48
|
+
- **redirected**: User changed approach or gave new instructions
|
|
49
|
+
|
|
50
|
+
**Refinement magnitude** (for medium/high effort only — how much changed from first attempt to final?):
|
|
51
|
+
- **none**: Accepted as-is, 0% changed
|
|
52
|
+
- **minor**: Small fixes — typos, naming, formatting (<10% changed)
|
|
53
|
+
- **moderate**: Logic or structural changes, added/removed sections (10–50% changed)
|
|
54
|
+
- **major**: Significant rework of approach or content (50–80% changed)
|
|
55
|
+
- **rework**: Mostly rewritten, original approach abandoned (>80% changed)
|
|
56
|
+
|
|
57
|
+
**Delta categories** (what kinds of changes were needed — select all that apply):
|
|
58
|
+
- **accuracy**: Factual errors or incorrect implementation
|
|
59
|
+
- **completeness**: Missing parts, incomplete coverage
|
|
60
|
+
- **approach**: Wrong method or strategy
|
|
61
|
+
- **scope**: Over-scoped or under-scoped
|
|
62
|
+
- **style**: Formatting, naming, conventions
|
|
63
|
+
|
|
43
64
|
## Observation checklist
|
|
44
65
|
|
|
45
66
|
At session close (or high-effort task completion), reflect on these before writing the entry:
|
|
@@ -54,6 +75,10 @@ At session close (or high-effort task completion), reflect on these before writi
|
|
|
54
75
|
9. How ambiguous was the user's request? (low / medium / high)
|
|
55
76
|
10. How much project context was loaded? (very low / low / medium / high / very high)
|
|
56
77
|
11. Approximate token usage and time spent?
|
|
78
|
+
12. How did the user respond to the result? (accepted / edited / revised / rejected / redirected)
|
|
79
|
+
13. For medium/high effort: how many revision cycles before acceptance?
|
|
80
|
+
14. What magnitude of change between first attempt and final result? (none / minor / moderate / major / rework)
|
|
81
|
+
15. What categories of refinement were needed? (accuracy / completeness / approach / scope / style)
|
|
57
82
|
|
|
58
83
|
## Entry format
|
|
59
84
|
|
|
@@ -66,6 +91,10 @@ Tokens: ~{N}k | Time: ~{N} min
|
|
|
66
91
|
Queries: {query types encountered}
|
|
67
92
|
Features: {feature IDs activated}
|
|
68
93
|
Cascades: {triggered}/{expected} | Decisions: {count}
|
|
94
|
+
Response: {accepted / edited / revised / rejected / redirected}
|
|
95
|
+
Revisions: {0 | count of revision cycles} | Magnitude: {none / minor / moderate / major / rework}
|
|
96
|
+
Delta: {n/a | categories: accuracy, completeness, approach, scope, style} | Survival: ~{N}%
|
|
97
|
+
Delta notes: {n/a | brief description of what changed between first attempt and final}
|
|
69
98
|
Friction: {none | brief description}
|
|
70
99
|
Finding: {none | observation with methodology implication}
|
|
71
100
|
-->
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Summary
|
|
2
|
+
|
|
3
|
+
<!-- AGENT: This file is the session audit trail — a chronological record of work done.
|
|
4
|
+
The management digest has moved to Management/DIGEST.md.
|
|
5
|
+
Append an entry after each session or significant task using the format below.
|
|
6
|
+
Never edit previous entries. -->
|
|
7
|
+
|
|
8
|
+
## Session audit trail
|
|
9
|
+
|
|
10
|
+
<!-- INSTRUCTION: Use this format for each entry:
|
|
11
|
+
|
|
12
|
+
### {Date} — {Brief title}
|
|
13
|
+
|
|
14
|
+
**Plan**: {What was planned for this session}
|
|
15
|
+
**Outcome**: {What was actually accomplished}
|
|
16
|
+
|
|
17
|
+
**Files created**:
|
|
18
|
+
- {path/to/new-file.md}
|
|
19
|
+
|
|
20
|
+
**Files updated**:
|
|
21
|
+
- {path/to/updated-file.md} — {what changed}
|
|
22
|
+
|
|
23
|
+
**Key decisions**:
|
|
24
|
+
- {Decision and rationale — should match what's in STATE.md}
|
|
25
|
+
|
|
26
|
+
**Next**: {What should happen in the following session — this is the bridge}
|
|
27
|
+
-->
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Agent Workflows
|
|
2
|
+
|
|
3
|
+
<!-- AGENT: This file tracks how the methodology performs in practice.
|
|
4
|
+
Update after high-effort sessions by reviewing SESSION-LOG.md patterns.
|
|
5
|
+
|
|
6
|
+
Source: SESSION-LOG.md entries, agent self-observation during sessions.
|
|
7
|
+
When this file exceeds 300 lines, split sections into individual files
|
|
8
|
+
in this directory (sessions.md, patterns.md, observations.md). -->
|
|
9
|
+
|
|
10
|
+
## Workflow summary
|
|
11
|
+
|
|
12
|
+
| Workflow | Times used | Last used | Typical effort |
|
|
13
|
+
|----------|-----------|-----------|---------------|
|
|
14
|
+
<!-- Populate from SESSION-LOG.md workflow field -->
|
|
15
|
+
|
|
16
|
+
## Session patterns
|
|
17
|
+
|
|
18
|
+
<!-- AGENT: Synthesize from SESSION-LOG.md. Look for patterns across sessions. -->
|
|
19
|
+
|
|
20
|
+
### Effort distribution
|
|
21
|
+
|
|
22
|
+
| Effort level | Count | Percentage |
|
|
23
|
+
|-------------|-------|------------|
|
|
24
|
+
| Low | {N} | {%} |
|
|
25
|
+
| Medium | {N} | {%} |
|
|
26
|
+
| High | {N} | {%} |
|
|
27
|
+
|
|
28
|
+
### Common query types
|
|
29
|
+
|
|
30
|
+
<!-- Which query types appear most often? -->
|
|
31
|
+
|
|
32
|
+
### Acceptance rates
|
|
33
|
+
|
|
34
|
+
<!-- How often is agent output accepted vs. revised? -->
|
|
35
|
+
|
|
36
|
+
- **Accepted**: {count} ({%})
|
|
37
|
+
- **Edited**: {count} ({%})
|
|
38
|
+
- **Revised**: {count} ({%})
|
|
39
|
+
- **Rejected**: {count} ({%})
|
|
40
|
+
- **Redirected**: {count} ({%})
|
|
41
|
+
|
|
42
|
+
## Behavioral patterns
|
|
43
|
+
|
|
44
|
+
<!-- AGENT: Record patterns observed across sessions. What works well, what causes friction. -->
|
|
45
|
+
|
|
46
|
+
### What works
|
|
47
|
+
|
|
48
|
+
<!-- Patterns that consistently lead to accepted results. -->
|
|
49
|
+
|
|
50
|
+
### Friction points
|
|
51
|
+
|
|
52
|
+
<!-- Recurring issues, methodology rules that cause difficulty. -->
|
|
53
|
+
|
|
54
|
+
## Observations
|
|
55
|
+
|
|
56
|
+
<!-- AGENT: Record methodology observations — findings with implications for
|
|
57
|
+
how the methodology could be improved or adapted for this project. -->
|
|
58
|
+
|
|
59
|
+
| Date | Observation | Implication | Severity |
|
|
60
|
+
|------|-------------|-------------|----------|
|
|
61
|
+
<!-- Append observations as they arise -->
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Methodology Overview
|
|
2
|
+
|
|
3
|
+
This project uses the **wwa** (Working With Agents) methodology for AI-agent-assisted development. The methodology gives your AI agent persistent memory, structured workflows, and scoped context loading across sessions.
|
|
4
|
+
|
|
5
|
+
## How it works
|
|
6
|
+
|
|
7
|
+
Your agent reads an entry point file (CLAUDE.md, .cursorrules, or AGENT.md) at the start of every session. That file tells the agent:
|
|
8
|
+
|
|
9
|
+
- **What to read** — scoping rules match your question to the right files
|
|
10
|
+
- **What to update** — cascade rules keep dependent files in sync
|
|
11
|
+
- **How to work** — workflows guide the agent through structured steps
|
|
12
|
+
|
|
13
|
+
Key files the agent manages:
|
|
14
|
+
|
|
15
|
+
| File | Purpose |
|
|
16
|
+
|------|---------|
|
|
17
|
+
| STATE.md | Decisions, blockers, current position (cross-session memory) |
|
|
18
|
+
| PLAN.md | Current task with verification criteria |
|
|
19
|
+
| ROADMAP.md | Phase breakdown with gate criteria |
|
|
20
|
+
| .context/BASE.md | Core project context — architecture, codebase map |
|
|
21
|
+
| .context/DOCS-MAP.md | Maps your project components to their documentation |
|
|
22
|
+
|
|
23
|
+
## Your project's docs/
|
|
24
|
+
|
|
25
|
+
The `docs/` folder is reserved for **your project's documentation** — API references, architecture guides, setup instructions, etc. It is not created at setup time. Instead, the agent proposes new docs/ files as your project grows, based on scaffolding rules in `.context/DOCS-MAP.md`.
|
|
26
|
+
|
|
27
|
+
## Full documentation
|
|
28
|
+
|
|
29
|
+
For the complete methodology guide, templates reference, and architecture docs:
|
|
30
|
+
|
|
31
|
+
**https://github.com/anthropics/agent-method**
|
|
32
|
+
|
|
33
|
+
Key pages:
|
|
34
|
+
- [Quick Start](https://github.com/anthropics/agent-method/blob/main/docs/guides/quick-start.md)
|
|
35
|
+
- [For Developers](https://github.com/anthropics/agent-method/blob/main/docs/guides/for-developers.md)
|
|
36
|
+
- [File Roles](https://github.com/anthropics/agent-method/blob/main/docs/architecture/file-roles.md)
|
|
37
|
+
- [CLI Tools](https://github.com/anthropics/agent-method/blob/main/docs/guides/for-developers/cli-tools.md)
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
# {Project Name} — Documentation
|
|
2
|
-
|
|
3
|
-
<!-- INSTRUCTION: This is the human-facing project dashboard.
|
|
4
|
-
It provides a high-level view of the project for non-agent audiences
|
|
5
|
-
(managers, reviewers, teammates). Keep it visual and navigable. -->
|
|
6
|
-
|
|
7
|
-
## Project overview
|
|
8
|
-
|
|
9
|
-
<!-- INSTRUCTION: Brief description of what the project does and its current state.
|
|
10
|
-
Link to PROJECT.md for the full vision. -->
|
|
11
|
-
|
|
12
|
-
See [PROJECT.md](../PROJECT.md) for the full project vision and scope.
|
|
13
|
-
|
|
14
|
-
## Current status
|
|
15
|
-
|
|
16
|
-
<!-- INSTRUCTION: Update this when phases complete. Show progress at a glance. -->
|
|
17
|
-
|
|
18
|
-
| Phase | Status | Gate |
|
|
19
|
-
|-------|--------|------|
|
|
20
|
-
| Phase 1 — {name} | {pending/in-progress/done} | {PASSED / not yet} |
|
|
21
|
-
| Phase 2 — {name} | {pending} | {not yet} |
|
|
22
|
-
|
|
23
|
-
## Architecture
|
|
24
|
-
|
|
25
|
-
<!-- INSTRUCTION: High-level architecture description for human readers.
|
|
26
|
-
Diagrams, component descriptions, key design decisions. -->
|
|
27
|
-
|
|
28
|
-
{Describe or diagram your project architecture}
|
|
29
|
-
|
|
30
|
-
## Key decisions
|
|
31
|
-
|
|
32
|
-
<!-- INSTRUCTION: Surface important decisions from STATE.md in a human-readable format.
|
|
33
|
-
Not every decision — just the ones that affect the project's direction. -->
|
|
34
|
-
|
|
35
|
-
| Decision | Rationale | Date |
|
|
36
|
-
|----------|-----------|------|
|
|
37
|
-
| {Important decision} | {Why} | {When} |
|
|
38
|
-
|
|
39
|
-
## Navigation
|
|
40
|
-
|
|
41
|
-
<!-- INSTRUCTION: Add links to other docs as you create them. -->
|
|
42
|
-
|
|
43
|
-
| Document | What it covers |
|
|
44
|
-
|----------|---------------|
|
|
45
|
-
| [PROJECT.md](../PROJECT.md) | Project vision and scope |
|
|
46
|
-
| [ROADMAP.md](../ROADMAP.md) | Phase breakdown and progress |
|