agent-method 1.5.12
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 +343 -0
- package/bin/wwa.js +115 -0
- package/docs/internal/cli-commands.yaml +259 -0
- package/docs/internal/doc-tokens.yaml +1103 -0
- package/docs/internal/feature-registry.yaml +1643 -0
- package/lib/boundaries.js +247 -0
- package/lib/cli/add.js +170 -0
- package/lib/cli/casestudy.js +1000 -0
- package/lib/cli/check.js +323 -0
- package/lib/cli/close.js +838 -0
- package/lib/cli/completion.js +735 -0
- package/lib/cli/deps.js +234 -0
- package/lib/cli/digest.js +73 -0
- package/lib/cli/doc-review.js +486 -0
- package/lib/cli/docs.js +315 -0
- package/lib/cli/helpers.js +198 -0
- package/lib/cli/implement.js +169 -0
- package/lib/cli/init.js +280 -0
- package/lib/cli/pipeline.js +206 -0
- package/lib/cli/plan.js +140 -0
- package/lib/cli/record.js +98 -0
- package/lib/cli/refine.js +202 -0
- package/lib/cli/report-helpers.js +113 -0
- package/lib/cli/review.js +76 -0
- package/lib/cli/routable.js +109 -0
- package/lib/cli/route.js +101 -0
- package/lib/cli/scan.js +133 -0
- package/lib/cli/serve.js +23 -0
- package/lib/cli/status.js +65 -0
- package/lib/cli/update-docs.js +574 -0
- package/lib/cli/upgrade.js +222 -0
- package/lib/cli/watch.js +32 -0
- package/lib/dependencies.js +196 -0
- package/lib/init.js +692 -0
- package/lib/mcp-server.js +612 -0
- package/lib/pipeline.js +907 -0
- package/lib/registry.js +132 -0
- package/lib/watcher.js +165 -0
- package/package.json +54 -0
- package/templates/README.md +363 -0
- package/templates/entry-points/.cursorrules +90 -0
- package/templates/entry-points/AGENT.md +90 -0
- package/templates/entry-points/CLAUDE.md +88 -0
- package/templates/extensions/MANIFEST.md +110 -0
- package/templates/extensions/analytical-system.md +96 -0
- package/templates/extensions/code-project.md +77 -0
- package/templates/extensions/data-exploration.md +117 -0
- package/templates/full/.context/BASE.md +101 -0
- package/templates/full/.context/COMPOSITION.md +47 -0
- package/templates/full/.context/INDEX.yaml +56 -0
- package/templates/full/.context/METHODOLOGY.md +246 -0
- package/templates/full/.context/PROTOCOL.yaml +169 -0
- package/templates/full/.context/REGISTRY.md +75 -0
- package/templates/full/.cursorrules +90 -0
- package/templates/full/AGENT.md +90 -0
- package/templates/full/CLAUDE.md +90 -0
- package/templates/full/Management/DIGEST.md +23 -0
- package/templates/full/Management/STATUS.md +46 -0
- package/templates/full/PLAN.md +67 -0
- package/templates/full/PROJECT-PROFILE.md +61 -0
- package/templates/full/PROJECT.md +80 -0
- package/templates/full/REQUIREMENTS.md +30 -0
- package/templates/full/ROADMAP.md +39 -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 +102 -0
- package/templates/full/STATE.md +42 -0
- package/templates/full/SUMMARY.md +27 -0
- 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/full/registry/feature-registry.yaml +25 -0
- package/templates/full/registry/features/catalog.yaml +743 -0
- package/templates/full/registry/features/protocol.yaml +121 -0
- package/templates/full/registry/features/routing.yaml +358 -0
- package/templates/full/registry/features/workflows.yaml +404 -0
- package/templates/full/todos/backlog.md +19 -0
- package/templates/starter/.context/BASE.md +66 -0
- package/templates/starter/.context/INDEX.yaml +51 -0
- package/templates/starter/.context/METHODOLOGY.md +228 -0
- package/templates/starter/.context/PROTOCOL.yaml +165 -0
- package/templates/starter/.cursorrules +90 -0
- package/templates/starter/AGENT.md +90 -0
- package/templates/starter/CLAUDE.md +90 -0
- package/templates/starter/Management/DIGEST.md +23 -0
- package/templates/starter/Management/STATUS.md +46 -0
- package/templates/starter/PLAN.md +67 -0
- package/templates/starter/PROJECT-PROFILE.md +44 -0
- package/templates/starter/PROJECT.md +80 -0
- package/templates/starter/ROADMAP.md +39 -0
- package/templates/starter/Reviews/INDEX.md +75 -0
- package/templates/starter/SESSION-LOG.md +102 -0
- package/templates/starter/STATE.md +42 -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/starter/registry/feature-registry.yaml +25 -0
- package/templates/starter/registry/features/catalog.yaml +743 -0
- package/templates/starter/registry/features/protocol.yaml +121 -0
- package/templates/starter/registry/features/routing.yaml +358 -0
- package/templates/starter/registry/features/workflows.yaml +404 -0
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# {Project Name} — Agent Entry Point
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: Replace {Project Name} and write a 1-2 sentence project description below -->
|
|
4
|
+
{Describe what your project does, its architecture, and key technologies.}
|
|
5
|
+
|
|
6
|
+
## On every query
|
|
7
|
+
|
|
8
|
+
1. This file is auto-loaded — read it first
|
|
9
|
+
2. Read `STATE.md` for current position, decisions, blockers
|
|
10
|
+
3. Read `.context/PROTOCOL.yaml` for scoping, cascade, and conventions
|
|
11
|
+
4. Scope query against PROTOCOL.yaml `scoping:` section
|
|
12
|
+
5. After work, check PROTOCOL.yaml `close_check` before ending response
|
|
13
|
+
|
|
14
|
+
## Settings
|
|
15
|
+
|
|
16
|
+
mode: checkpoint
|
|
17
|
+
<!-- autonomous | checkpoint | collaborative | supervised -->
|
|
18
|
+
<!-- checkpoint: propose plan, wait for approval, report at completion (default) -->
|
|
19
|
+
|
|
20
|
+
tier: full
|
|
21
|
+
<!-- lite | standard | full -->
|
|
22
|
+
<!-- lite: minimal rules, STATE.md only — for Haiku or simple projects -->
|
|
23
|
+
<!-- standard: core rules + context pairing — for Sonnet (default) -->
|
|
24
|
+
<!-- full: all rules, all intelligence layer files — for Opus or complex projects -->
|
|
25
|
+
|
|
26
|
+
method_version: 1.6
|
|
27
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
28
|
+
|
|
29
|
+
## CLI tools (optional)
|
|
30
|
+
|
|
31
|
+
Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
|
|
32
|
+
|
|
33
|
+
| When you want to... | Run |
|
|
34
|
+
|---------------------|-----|
|
|
35
|
+
| Validate this entry point | `wwa check` |
|
|
36
|
+
| See what type of project this is | `wwa scan` |
|
|
37
|
+
| Test how a query routes | `wwa project-discovery` / `wwa context-refresh` / `wwa plan-create` (see CLI docs) |
|
|
38
|
+
| See current plan status | `wwa plan` |
|
|
39
|
+
| Get implementation guidance | `wwa implement` |
|
|
40
|
+
| View project review dashboard | `wwa review` |
|
|
41
|
+
| Show management digest | `wwa digest` |
|
|
42
|
+
| Session close + project snapshot | `wwa close` |
|
|
43
|
+
| Extract a refinement report | `wwa refine` |
|
|
44
|
+
| Extract a case study (with project tokens) | `wwa casestudy` |
|
|
45
|
+
| Check docs coverage | `wwa docs` |
|
|
46
|
+
| Show dependency graph | `wwa deps` |
|
|
47
|
+
| Generate document registry | `wwa doc-review` |
|
|
48
|
+
| Check methodology version | `wwa status` |
|
|
49
|
+
| Update methodology files | `wwa upgrade` |
|
|
50
|
+
| Set up a new project | `wwa init` |
|
|
51
|
+
| Run project discovery workflow | `wwa project-discovery` |
|
|
52
|
+
| Run context refresh workflow | `wwa context-refresh` |
|
|
53
|
+
| Run phase completion workflow | `wwa phase-complete` |
|
|
54
|
+
| Show routing for backlog | `wwa backlog` |
|
|
55
|
+
| Run planning workflow | `wwa plan-create` |
|
|
56
|
+
| Run dependency analysis workflow | `wwa dependency-analysis` |
|
|
57
|
+
| Run debt assessment workflow | `wwa debt-assessment` |
|
|
58
|
+
| Run docs update workflow | `wwa docs-update` |
|
|
59
|
+
| Run cross-reference workflow | `wwa cross-reference` |
|
|
60
|
+
| Append to backlog / decision / finding / session / summary | `wwa add <type> [content]` |
|
|
61
|
+
|
|
62
|
+
When doing **project review** or **self-review** sessions, use the collection checklist for capture format: `docs/internal/review/collection-checklist.md` (if present).
|
|
63
|
+
|
|
64
|
+
<!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
|
|
65
|
+
project setup, or methodology updates. All commands auto-detect project type and find
|
|
66
|
+
entry points automatically. Add --json for machine-readable output. -->
|
|
67
|
+
|
|
68
|
+
## Do not
|
|
69
|
+
|
|
70
|
+
- Modify project source code, tests, or pre-existing documentation through methodology operations — only create/modify methodology files (STATE.md, .context/, PLAN.md, etc.)
|
|
71
|
+
- Delete existing project files during brownfield integration — methodology is additive only
|
|
72
|
+
- Load files not in PROTOCOL.yaml scoping read-set for the current query type
|
|
73
|
+
- Defer STATE.md decision recording to end of session
|
|
74
|
+
- Skip cascade checks after file changes
|
|
75
|
+
- Load multiple specialist .context/ files for a single query
|
|
76
|
+
- Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
|
|
77
|
+
|
|
78
|
+
<!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
|
|
79
|
+
|
|
80
|
+
## First session
|
|
81
|
+
|
|
82
|
+
<!-- AGENT: If PROJECT.md contains {placeholder} text, this is a first session. -->
|
|
83
|
+
Follow the onboarding protocol in `.context/METHODOLOGY.md` — it guides you through
|
|
84
|
+
greenfield (4 stages) or brownfield (5 stages) setup with checkpoints at each step.
|
|
85
|
+
|
|
86
|
+
## Before ending this response
|
|
87
|
+
|
|
88
|
+
Read `.context/PROTOCOL.yaml` `close_check`. For each triggered item,
|
|
89
|
+
update the target file now. A response that modifies files but skips
|
|
90
|
+
triggered obligations is incomplete.
|
|
@@ -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} |
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Current Plan
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: This file contains ONE task at a time. Replace the entire
|
|
4
|
+
contents when starting a new task — never accumulate multiple plans.
|
|
5
|
+
The agent proposes the plan and waits for human approval before executing. -->
|
|
6
|
+
|
|
7
|
+
## {Task name}
|
|
8
|
+
|
|
9
|
+
### Objective
|
|
10
|
+
|
|
11
|
+
{What this task achieves. One clear sentence.}
|
|
12
|
+
|
|
13
|
+
### Prerequisites
|
|
14
|
+
|
|
15
|
+
<!-- INSTRUCTION: What must be true before starting this task? -->
|
|
16
|
+
|
|
17
|
+
- {Prior phase or task complete}
|
|
18
|
+
- {Required files or context available}
|
|
19
|
+
|
|
20
|
+
### Dependencies
|
|
21
|
+
|
|
22
|
+
<!-- INSTRUCTION: What depends on this task? What does this task block? -->
|
|
23
|
+
|
|
24
|
+
- {Phase/task that depends on this completing}
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
### Step 1: {Step name}
|
|
29
|
+
|
|
30
|
+
**Objective**: {What this step achieves}
|
|
31
|
+
|
|
32
|
+
**Read**: {Files to read before this step}
|
|
33
|
+
**Produce**: {Files created or modified by this step}
|
|
34
|
+
|
|
35
|
+
**Substeps**:
|
|
36
|
+
- a. {First substep}
|
|
37
|
+
- b. {Second substep}
|
|
38
|
+
|
|
39
|
+
**Verify**: {How to confirm this step is complete and correct}
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
### Step 2: {Step name}
|
|
44
|
+
|
|
45
|
+
**Objective**: {What this step achieves}
|
|
46
|
+
|
|
47
|
+
**Read**: {Files to read}
|
|
48
|
+
**Produce**: {Files created or modified}
|
|
49
|
+
|
|
50
|
+
**Verify**: {Verification criteria}
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
<!-- INSTRUCTION: Add more steps as needed. Each step should have:
|
|
55
|
+
- Clear objective
|
|
56
|
+
- Read/produce specs (what files are involved)
|
|
57
|
+
- Substeps (if complex)
|
|
58
|
+
- Verification criteria (how to confirm it's done right) -->
|
|
59
|
+
|
|
60
|
+
### Completion criteria
|
|
61
|
+
|
|
62
|
+
{Task name} is done when:
|
|
63
|
+
1. {Criterion 1 — specific and measurable}
|
|
64
|
+
2. {Criterion 2}
|
|
65
|
+
3. {Criterion 3}
|
|
66
|
+
|
|
67
|
+
**Next after {task name}**: {What comes next}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Project Profile
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: This file is maintained by the agent. It tracks your project's
|
|
4
|
+
type, lifecycle stage, and active extensions. The agent reads this to adjust
|
|
5
|
+
feature priorities and workflow selection. You can also update it manually
|
|
6
|
+
when your project's situation changes.
|
|
7
|
+
|
|
8
|
+
Fill in the initial values during setup. The agent updates lifecycle stage
|
|
9
|
+
and maturity as the project evolves. -->
|
|
10
|
+
|
|
11
|
+
## Project identity
|
|
12
|
+
|
|
13
|
+
- **Types**: [{project-type}]
|
|
14
|
+
- **Extensions**: [{extensions-applied}]
|
|
15
|
+
|
|
16
|
+
<!-- INSTRUCTION: Project types: code, data, analytical, mixed, general.
|
|
17
|
+
Extensions: code-project, data-exploration, analytical-system, or none. -->
|
|
18
|
+
|
|
19
|
+
## Lifecycle
|
|
20
|
+
|
|
21
|
+
- **Stage**: {stage}
|
|
22
|
+
- **Maturity**: {maturity}
|
|
23
|
+
- **Last transition**: {date} ({from} -> {to})
|
|
24
|
+
|
|
25
|
+
<!-- INSTRUCTION: Lifecycle stages:
|
|
26
|
+
- discovery: Understanding an existing project (brownfield entry)
|
|
27
|
+
- design: Defining architecture and structure (greenfield start)
|
|
28
|
+
- development: Building and iterating (active implementation)
|
|
29
|
+
- evolution: Maintaining and extending (stable baseline)
|
|
30
|
+
|
|
31
|
+
Maturity levels: new, early, established, legacy.
|
|
32
|
+
The agent suggests transitions; you decide when to move. -->
|
|
33
|
+
|
|
34
|
+
## Extension stack
|
|
35
|
+
|
|
36
|
+
| Extension | Applied | Source |
|
|
37
|
+
|-----------|---------|--------|
|
|
38
|
+
| code-project | {yes/no} | {setup.sh / manual} |
|
|
39
|
+
| data-exploration | {yes/no} | {setup.sh / manual} |
|
|
40
|
+
| analytical-system | {yes/no} | {setup.sh / manual} |
|
|
41
|
+
|
|
42
|
+
<!-- INSTRUCTION: Track which extensions are active. Extensions can be added
|
|
43
|
+
mid-project without re-running setup.sh — merge the extension file
|
|
44
|
+
into your entry point manually and update this table. -->
|
|
45
|
+
|
|
46
|
+
## Discovery log
|
|
47
|
+
|
|
48
|
+
<!-- INSTRUCTION: When the agent runs WF-08 (discovery workflow), key findings
|
|
49
|
+
are recorded here for quick reference. Only used during Discovery stage.
|
|
50
|
+
Can be deleted once the project moves to Development or Evolution. -->
|
|
51
|
+
|
|
52
|
+
| Date | Finding | Severity | Action taken |
|
|
53
|
+
|------|---------|----------|-------------|
|
|
54
|
+
|
|
55
|
+
## Context evolution history
|
|
56
|
+
|
|
57
|
+
<!-- INSTRUCTION: Track lifecycle transitions and extension changes over time.
|
|
58
|
+
Helps the agent understand how the project has evolved. -->
|
|
59
|
+
|
|
60
|
+
| Date | Change | Rationale |
|
|
61
|
+
|------|--------|-----------|
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# {Your Project Name}
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: Replace with a 2-3 sentence description of your project.
|
|
4
|
+
Include what it does, who it's for, and what technologies it uses. -->
|
|
5
|
+
{Describe what your project does and who it's for}
|
|
6
|
+
|
|
7
|
+
## Problem
|
|
8
|
+
|
|
9
|
+
<!-- INSTRUCTION: What problem does this solve? 2-3 bullet points. -->
|
|
10
|
+
|
|
11
|
+
- {Problem statement 1}
|
|
12
|
+
- {Problem statement 2}
|
|
13
|
+
|
|
14
|
+
## Solution
|
|
15
|
+
|
|
16
|
+
<!-- INSTRUCTION: How does the project solve the problem? Brief description of the approach. -->
|
|
17
|
+
|
|
18
|
+
{Describe your approach}
|
|
19
|
+
|
|
20
|
+
## Project structure
|
|
21
|
+
|
|
22
|
+
<!-- INSTRUCTION: Table of top-level directories and their purposes.
|
|
23
|
+
The agent uses this to understand the project layout.
|
|
24
|
+
For existing codebases, ask the agent to help populate this from a scan. -->
|
|
25
|
+
|
|
26
|
+
| Path | Purpose |
|
|
27
|
+
|------|---------|
|
|
28
|
+
| {src/} | {Source code} |
|
|
29
|
+
| {docs/} | {Documentation} |
|
|
30
|
+
|
|
31
|
+
## Audiences
|
|
32
|
+
|
|
33
|
+
<!-- INSTRUCTION: Who interacts with this project? Users, developers, managers, agents? -->
|
|
34
|
+
|
|
35
|
+
| Audience | What they need |
|
|
36
|
+
|----------|---------------|
|
|
37
|
+
| {Developer} | {Working code, clear architecture} |
|
|
38
|
+
| {User} | {Functional product} |
|
|
39
|
+
|
|
40
|
+
## Principles
|
|
41
|
+
|
|
42
|
+
<!-- INSTRUCTION: 3-5 guiding principles for decision-making on this project. -->
|
|
43
|
+
|
|
44
|
+
1. {Principle 1}
|
|
45
|
+
2. {Principle 2}
|
|
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,30 @@
|
|
|
1
|
+
# Requirements
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: Define what the project must achieve. Each requirement has an ID,
|
|
4
|
+
description, phase traceability, and status. Requirements drive the ROADMAP. -->
|
|
5
|
+
|
|
6
|
+
## Functional requirements
|
|
7
|
+
|
|
8
|
+
| ID | Requirement | Phase | Status |
|
|
9
|
+
|----|-------------|-------|--------|
|
|
10
|
+
| R1 | {What the system must do} | {Phase #} | pending |
|
|
11
|
+
| R2 | {Second requirement} | {Phase #} | pending |
|
|
12
|
+
| R3 | {Third requirement} | {Phase #} | pending |
|
|
13
|
+
|
|
14
|
+
<!-- INSTRUCTION: Add requirements as they're identified. Link each to the phase
|
|
15
|
+
where it will be delivered. Mark "done" when the phase gate passes. -->
|
|
16
|
+
|
|
17
|
+
## Non-functional requirements
|
|
18
|
+
|
|
19
|
+
| ID | Requirement | Phase | Status |
|
|
20
|
+
|----|-------------|-------|--------|
|
|
21
|
+
| NF1 | {Performance, security, or usability requirement} | {Phase #} | pending |
|
|
22
|
+
|
|
23
|
+
## Traceability
|
|
24
|
+
|
|
25
|
+
<!-- INSTRUCTION: This section maps requirements to deliverables.
|
|
26
|
+
Update when requirements are completed or deliverables change. -->
|
|
27
|
+
|
|
28
|
+
| Requirement | Delivered by | Verified by |
|
|
29
|
+
|-------------|-------------|-------------|
|
|
30
|
+
| R1 | {Deliverable name or file} | {How it was verified} |
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Roadmap
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: Define phases with deliverables and gate criteria.
|
|
4
|
+
Each phase should have:
|
|
5
|
+
- A clear objective (1 sentence)
|
|
6
|
+
- A deliverable table (what, requirement, status)
|
|
7
|
+
- A gate (how you know the phase is done)
|
|
8
|
+
Copy the Phase template below for each phase in your project. -->
|
|
9
|
+
|
|
10
|
+
## Phase 1 — {Phase name} [status]
|
|
11
|
+
|
|
12
|
+
<!-- INSTRUCTION: Replace {Phase name} with a descriptive name.
|
|
13
|
+
Set [status] to one of: current, pending, done -->
|
|
14
|
+
|
|
15
|
+
{One sentence describing what this phase achieves.}
|
|
16
|
+
|
|
17
|
+
| Deliverable | Requirement | Status |
|
|
18
|
+
|-------------|-------------|--------|
|
|
19
|
+
| {Deliverable 1} | {Which requirement it satisfies} | pending |
|
|
20
|
+
| {Deliverable 2} | {Which requirement it satisfies} | pending |
|
|
21
|
+
|
|
22
|
+
**Gate**: {How you know this phase is complete. Be specific — measurable criteria.}
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Phase 2 — {Phase name} [pending]
|
|
27
|
+
|
|
28
|
+
{One sentence describing what this phase achieves.}
|
|
29
|
+
|
|
30
|
+
| Deliverable | Requirement | Status |
|
|
31
|
+
|-------------|-------------|--------|
|
|
32
|
+
| {Deliverable 1} | {Requirement} | pending |
|
|
33
|
+
|
|
34
|
+
**Gate**: {Completion criteria}
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
<!-- INSTRUCTION: Add more phases as needed. Each phase should be achievable
|
|
39
|
+
in 1-5 sessions. If a phase takes longer, split it. -->
|
|
@@ -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? -->
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Project Review
|
|
2
|
+
|
|
3
|
+
<!-- AGENT: Synthesize from PROJECT.md and PROJECT-PROFILE.md. Track how the project
|
|
4
|
+
vision, scope, and principles evolve over time. Update after significant scope
|
|
5
|
+
changes, audience shifts, or principle revisions.
|
|
6
|
+
|
|
7
|
+
Source: PROJECT.md, PROJECT-PROFILE.md
|
|
8
|
+
Parent: Reviews/INDEX.md (update "At a glance" row when this changes) -->
|
|
9
|
+
|
|
10
|
+
## Project identity
|
|
11
|
+
|
|
12
|
+
| Field | Current value |
|
|
13
|
+
|-------|--------------|
|
|
14
|
+
| Name | {from PROJECT.md} |
|
|
15
|
+
| Type | {from PROJECT-PROFILE.md} |
|
|
16
|
+
| Lifecycle stage | {from PROJECT-PROFILE.md} |
|
|
17
|
+
| Active extensions | {from PROJECT-PROFILE.md} |
|
|
18
|
+
|
|
19
|
+
## Scope evolution
|
|
20
|
+
|
|
21
|
+
<!-- AGENT: Track how project scope has changed. Has it grown, contracted, or shifted? -->
|
|
22
|
+
|
|
23
|
+
| Date | Change | Type | Impact |
|
|
24
|
+
|------|--------|------|--------|
|
|
25
|
+
<!-- {date} | {what changed} | {expansion / contraction / pivot} | {brief impact} -->
|
|
26
|
+
|
|
27
|
+
## Principle adherence
|
|
28
|
+
|
|
29
|
+
<!-- AGENT: Review PROJECT.md principles. Are they being followed in practice? -->
|
|
30
|
+
|
|
31
|
+
| Principle | Status | Evidence |
|
|
32
|
+
|-----------|--------|----------|
|
|
33
|
+
<!-- {principle from PROJECT.md} | {followed / at risk / violated} | {brief evidence} -->
|
|
34
|
+
|
|
35
|
+
## Audience alignment
|
|
36
|
+
|
|
37
|
+
<!-- AGENT: Are we building for the right audience? Any shifts in who uses this? -->
|
|
38
|
+
|
|
39
|
+
## Technology health
|
|
40
|
+
|
|
41
|
+
<!-- AGENT: Are technology choices from PROJECT.md still appropriate? Any concerns? -->
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Requirements Review
|
|
2
|
+
|
|
3
|
+
<!-- AGENT: Synthesize from REQUIREMENTS.md. Track requirements coverage, completion
|
|
4
|
+
status, and traceability to roadmap phases. Update after requirement changes
|
|
5
|
+
or phase completions that satisfy requirements.
|
|
6
|
+
|
|
7
|
+
Source: REQUIREMENTS.md, ROADMAP.md (phase mapping)
|
|
8
|
+
Parent: Reviews/INDEX.md (update "At a glance" row when this changes) -->
|
|
9
|
+
|
|
10
|
+
## Coverage summary
|
|
11
|
+
|
|
12
|
+
| Status | Count | Percentage |
|
|
13
|
+
|--------|-------|------------|
|
|
14
|
+
| Done | {N} | {%} |
|
|
15
|
+
| In progress | {N} | {%} |
|
|
16
|
+
| Pending | {N} | {%} |
|
|
17
|
+
| Deferred | {N} | {%} |
|
|
18
|
+
| **Total** | {N} | 100% |
|
|
19
|
+
|
|
20
|
+
## Traceability matrix
|
|
21
|
+
|
|
22
|
+
<!-- AGENT: Map requirements to roadmap phases. Which phases satisfy which requirements? -->
|
|
23
|
+
|
|
24
|
+
| Requirement | Description | Phase | Status |
|
|
25
|
+
|-------------|-------------|-------|--------|
|
|
26
|
+
<!-- {R-ID} | {brief description} | {phase} | {done / in progress / pending} -->
|
|
27
|
+
|
|
28
|
+
## Coverage gaps
|
|
29
|
+
|
|
30
|
+
<!-- AGENT: Are there requirements with no clear path to completion? -->
|
|
31
|
+
|
|
32
|
+
| Requirement | Gap description | Risk |
|
|
33
|
+
|-------------|----------------|------|
|
|
34
|
+
<!-- Requirements not yet mapped to a phase or at risk of being unmet -->
|
|
35
|
+
|
|
36
|
+
## Change history
|
|
37
|
+
|
|
38
|
+
<!-- AGENT: Track when requirements are added, modified, or removed. -->
|
|
39
|
+
|
|
40
|
+
| Date | Requirement | Change | Rationale |
|
|
41
|
+
|------|-------------|--------|-----------|
|
|
42
|
+
<!-- {date} | {R-ID} | {added / modified / removed} | {why} -->
|