ai-devkit 0.2.0
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/CHANGELOG.md +49 -0
- package/README.md +364 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +24 -0
- package/dist/cli.js.map +1 -0
- package/dist/commands/init.d.ts +9 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/init.js +162 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/phase.d.ts +2 -0
- package/dist/commands/phase.d.ts.map +1 -0
- package/dist/commands/phase.js +83 -0
- package/dist/commands/phase.js.map +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +23 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/Config.d.ts +12 -0
- package/dist/lib/Config.d.ts.map +1 -0
- package/dist/lib/Config.js +94 -0
- package/dist/lib/Config.js.map +1 -0
- package/dist/lib/TemplateManager.d.ts +13 -0
- package/dist/lib/TemplateManager.d.ts.map +1 -0
- package/dist/lib/TemplateManager.js +129 -0
- package/dist/lib/TemplateManager.js.map +1 -0
- package/dist/types.d.ts +17 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +22 -0
- package/dist/types.js.map +1 -0
- package/package.json +46 -0
- package/templates/env/claude/CLAUDE.md +52 -0
- package/templates/env/claude/commands/check-implementation.md +21 -0
- package/templates/env/claude/commands/code-review.md +81 -0
- package/templates/env/claude/commands/execute-plan.md +71 -0
- package/templates/env/claude/commands/new-requirement.md +127 -0
- package/templates/env/claude/commands/review-design.md +11 -0
- package/templates/env/claude/commands/review-requirements.md +9 -0
- package/templates/env/claude/commands/update-planning.md +61 -0
- package/templates/env/claude/commands/writing-test.md +44 -0
- package/templates/env/cursor/commands/check-implementation.md +21 -0
- package/templates/env/cursor/commands/code-review.md +81 -0
- package/templates/env/cursor/commands/execute-plan.md +71 -0
- package/templates/env/cursor/commands/new-requirement.md +127 -0
- package/templates/env/cursor/commands/review-design.md +11 -0
- package/templates/env/cursor/commands/review-requirements.md +9 -0
- package/templates/env/cursor/commands/update-planning.md +61 -0
- package/templates/env/cursor/commands/writing-test.md +44 -0
- package/templates/env/cursor/rules/ai-devkit.md +51 -0
- package/templates/phases/deployment.md +72 -0
- package/templates/phases/design.md +60 -0
- package/templates/phases/implementation.md +65 -0
- package/templates/phases/monitoring.md +80 -0
- package/templates/phases/planning.md +60 -0
- package/templates/phases/requirements.md +51 -0
- package/templates/phases/testing.md +81 -0
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Feature Plan Execution Assistant (Claude)
|
|
2
|
+
|
|
3
|
+
Help me work through a feature plan one task at a time.
|
|
4
|
+
|
|
5
|
+
## Step 1: Gather Context
|
|
6
|
+
Ask me for:
|
|
7
|
+
- Feature name (kebab-case, e.g., `user-authentication`)
|
|
8
|
+
- Brief feature/branch description
|
|
9
|
+
- Relevant planning doc path (default `docs/ai/planning/feature-{name}.md`)
|
|
10
|
+
- Any supporting design/implementation docs (design, requirements, implementation)
|
|
11
|
+
- Current branch and latest diff summary (`git status -sb`, `git diff --stat`)
|
|
12
|
+
|
|
13
|
+
## Step 2: Load the Plan
|
|
14
|
+
- Request the planning doc contents or offer commands like:
|
|
15
|
+
```bash
|
|
16
|
+
cat docs/ai/planning/feature-<name>.md
|
|
17
|
+
```
|
|
18
|
+
- Parse sections that represent task lists (look for headings + checkboxes `[ ]`, `[x]`).
|
|
19
|
+
- Build an ordered queue of tasks grouped by section (e.g., Foundation, Core Features, Testing).
|
|
20
|
+
|
|
21
|
+
## Step 3: Present Task Queue
|
|
22
|
+
Show an overview:
|
|
23
|
+
```
|
|
24
|
+
### Task Queue: <Feature Name>
|
|
25
|
+
1. [status] Section • Task title
|
|
26
|
+
2. ...
|
|
27
|
+
```
|
|
28
|
+
Status legend: `todo`, `in-progress`, `done`, `blocked` (based on checkbox/notes if present).
|
|
29
|
+
|
|
30
|
+
## Step 4: Interactive Task Execution
|
|
31
|
+
For each task in order:
|
|
32
|
+
1. Display the section/context, full bullet text, and any existing notes.
|
|
33
|
+
2. Suggest relevant docs to reference (requirements/design/implementation).
|
|
34
|
+
3. Ask: "Plan for this task?" Offer to outline sub-steps using the design doc.
|
|
35
|
+
4. Prompt to mark status (`done`, `in-progress`, `blocked`, `skipped`) and capture short notes/next steps.
|
|
36
|
+
5. Encourage code/document edits inside Claude; offer commands/snippets when useful.
|
|
37
|
+
6. If blocked, record blocker info and move task to the end or into a "Blocked" list.
|
|
38
|
+
|
|
39
|
+
## Step 5: Update Planning Doc
|
|
40
|
+
After each status change, generate a Markdown snippet the user can paste back into the planning doc, e.g.:
|
|
41
|
+
```
|
|
42
|
+
- [x] Task: Implement auth service (Notes: finished POST /auth/login, tests added)
|
|
43
|
+
```
|
|
44
|
+
Remind the user to keep the source doc updated.
|
|
45
|
+
|
|
46
|
+
## Step 6: Check for Newly Discovered Work
|
|
47
|
+
After each section, ask if new tasks were discovered. If yes, capture them in a "New Work" list with status `todo` and include in the summary.
|
|
48
|
+
|
|
49
|
+
## Step 7: Session Summary
|
|
50
|
+
Produce a summary table:
|
|
51
|
+
```
|
|
52
|
+
### Execution Summary
|
|
53
|
+
- Completed: (list)
|
|
54
|
+
- In Progress: (list + owners/next steps)
|
|
55
|
+
- Blocked: (list + blockers)
|
|
56
|
+
- Skipped / Deferred: (list + rationale)
|
|
57
|
+
- New Tasks: (list)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Step 8: Next Actions
|
|
61
|
+
Remind the user to:
|
|
62
|
+
- Update `docs/ai/planning/feature-{name}.md` with the new statuses
|
|
63
|
+
- Sync related docs (requirements/design/implementation/testing) if decisions changed
|
|
64
|
+
- Run `check-implementation` to validate changes against design docs
|
|
65
|
+
- Run `writing-test` to produce unit/integration tests targeting 100% coverage
|
|
66
|
+
- Run `update-planning` to reconcile the planning doc with the latest status
|
|
67
|
+
- Run the `code-review` command when ready for final review
|
|
68
|
+
- Run test suites relevant to completed tasks
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
Let me know when you're ready to start executing the plan. Provide the feature name and planning doc first.
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
I want to add a new feature/requirement. Please guide me through the complete development workflow:
|
|
2
|
+
|
|
3
|
+
## Step 1: Capture Requirement
|
|
4
|
+
First, ask me:
|
|
5
|
+
- What is the feature name? (e.g., "user-authentication", "payment-integration")
|
|
6
|
+
- What problem does it solve?
|
|
7
|
+
- Who will use it?
|
|
8
|
+
- What are the key user stories?
|
|
9
|
+
|
|
10
|
+
## Step 2: Create Feature Documentation Structure
|
|
11
|
+
Once I provide the requirement, create the following files (copy the existing template content so sections/frontmatter match exactly):
|
|
12
|
+
- Start from `docs/ai/requirements/README.md` → save as `docs/ai/requirements/feature-{name}.md`
|
|
13
|
+
- Start from `docs/ai/design/README.md` → save as `docs/ai/design/feature-{name}.md`
|
|
14
|
+
- Start from `docs/ai/planning/README.md` → save as `docs/ai/planning/feature-{name}.md`
|
|
15
|
+
- Start from `docs/ai/implementation/README.md` → save as `docs/ai/implementation/feature-{name}.md`
|
|
16
|
+
- Start from `docs/ai/testing/README.md` → save as `docs/ai/testing/feature-{name}.md`
|
|
17
|
+
|
|
18
|
+
Ensure the YAML frontmatter and section headings remain identical to the templates before filling in feature-specific content.
|
|
19
|
+
|
|
20
|
+
## Step 3: Requirements Phase
|
|
21
|
+
Help me fill out `docs/ai/requirements/feature-{name}.md`:
|
|
22
|
+
- Clarify the problem statement
|
|
23
|
+
- Define goals and non-goals
|
|
24
|
+
- Write detailed user stories
|
|
25
|
+
- Establish success criteria
|
|
26
|
+
- Identify constraints and assumptions
|
|
27
|
+
- List open questions
|
|
28
|
+
|
|
29
|
+
## Step 4: Design Phase
|
|
30
|
+
Guide me through `docs/ai/design/feature-{name}.md`:
|
|
31
|
+
- Propose system architecture changes needed
|
|
32
|
+
- Define data models/schema changes
|
|
33
|
+
- Design API endpoints or interfaces
|
|
34
|
+
- Identify components to create/modify
|
|
35
|
+
- Document key design decisions
|
|
36
|
+
- Note security and performance considerations
|
|
37
|
+
|
|
38
|
+
## Step 5: Planning Phase
|
|
39
|
+
Help me break down work in `docs/ai/planning/feature-{name}.md`:
|
|
40
|
+
- Create task breakdown with subtasks
|
|
41
|
+
- Identify dependencies (on other features, APIs, etc.)
|
|
42
|
+
- Estimate effort for each task
|
|
43
|
+
- Suggest implementation order
|
|
44
|
+
- Identify risks and mitigation strategies
|
|
45
|
+
|
|
46
|
+
## Step 6: Documentation Review (Chained Commands)
|
|
47
|
+
Once the docs above are drafted, run the following commands to tighten them up:
|
|
48
|
+
- `review-requirements` to validate the requirements doc for completeness and clarity
|
|
49
|
+
- `review-design` to ensure the design doc aligns with requirements and highlights key decisions
|
|
50
|
+
|
|
51
|
+
(If you are in Cursor, use `/review-requirements` and `/review-design`.)
|
|
52
|
+
|
|
53
|
+
## Step 7: Implementation Phase (Deferred)
|
|
54
|
+
This command focuses on documentation only. Actual implementation happens later via `execute-plan`.
|
|
55
|
+
For each task in the plan:
|
|
56
|
+
1. Review the task requirements and design
|
|
57
|
+
2. Ask me to confirm I'm starting this task
|
|
58
|
+
3. Guide implementation with reference to design docs
|
|
59
|
+
4. Suggest code structure and patterns
|
|
60
|
+
5. Help with error handling and edge cases
|
|
61
|
+
6. Update `docs/ai/implementation/feature-{name}.md` with notes
|
|
62
|
+
|
|
63
|
+
## Step 8: Testing Phase
|
|
64
|
+
Guide testing in `docs/ai/testing/feature-{name}.md`:
|
|
65
|
+
- Draft unit test cases with `writing-test`
|
|
66
|
+
- Draft integration test scenarios with `writing-test`
|
|
67
|
+
- Recommend manual testing steps
|
|
68
|
+
- Help write test code
|
|
69
|
+
- Verify all success criteria are testable
|
|
70
|
+
|
|
71
|
+
## Step 9: Local Testing & Verification
|
|
72
|
+
Guide me through:
|
|
73
|
+
1. Running all tests locally
|
|
74
|
+
2. Manual testing checklist
|
|
75
|
+
3. Reviewing against requirements
|
|
76
|
+
4. Checking design compliance
|
|
77
|
+
5. Preparing for code review (diff summary, list of files, design references)
|
|
78
|
+
|
|
79
|
+
## Step 10: Local Code Review (Optional but recommended)
|
|
80
|
+
Before pushing, ask me to run the `code-review` command with the modified file list and relevant docs.
|
|
81
|
+
|
|
82
|
+
## Step 11: Implementation Execution Reminder
|
|
83
|
+
When ready to implement, run `execute-plan` to work through the planning doc tasks interactively. That command will orchestrate implementation, testing, and follow-up documentation.
|
|
84
|
+
|
|
85
|
+
## Step 12: Create Merge/Pull Request
|
|
86
|
+
Provide the MR/PR description:
|
|
87
|
+
```markdown
|
|
88
|
+
## Feature: [Feature Name]
|
|
89
|
+
|
|
90
|
+
### Summary
|
|
91
|
+
[Brief description of what this feature does]
|
|
92
|
+
|
|
93
|
+
### Requirements
|
|
94
|
+
- Documented in: `docs/ai/requirements/feature-{name}.md`
|
|
95
|
+
- Related to: [issue/ticket number if applicable]
|
|
96
|
+
|
|
97
|
+
### Changes
|
|
98
|
+
- [List key changes]
|
|
99
|
+
- [List new files/components]
|
|
100
|
+
- [List modified files]
|
|
101
|
+
|
|
102
|
+
### Design
|
|
103
|
+
- Architecture: [Link to design doc section]
|
|
104
|
+
- Key decisions: [Brief summary]
|
|
105
|
+
|
|
106
|
+
### Testing
|
|
107
|
+
- Unit tests: [coverage/status]
|
|
108
|
+
- Integration tests: [status]
|
|
109
|
+
- Manual testing: ✓ Completed
|
|
110
|
+
- Test documentation: `docs/ai/testing/feature-{name}.md`
|
|
111
|
+
|
|
112
|
+
### Checklist
|
|
113
|
+
- [ ] Code follows project standards
|
|
114
|
+
- [ ] All tests pass
|
|
115
|
+
- [ ] Documentation updated
|
|
116
|
+
- [ ] No breaking changes (or documented if any)
|
|
117
|
+
- [ ] Ready for review
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Then provide the appropriate command:
|
|
121
|
+
- **GitHub**: `gh pr create --title "feat: [feature-name]" --body-file pr-description.md`
|
|
122
|
+
- **GitLab**: `glab mr create --title "feat: [feature-name]" --description "$(cat mr-description.md)"`
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
**Let's start! Tell me about the feature you want to build.**
|
|
127
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
Review the design documentation in docs/ai/design/feature-{name}.md (and the project-level README if relevant). Summarize:
|
|
2
|
+
- Architecture overview (ensure mermaid diagram is present and accurate)
|
|
3
|
+
- Key components and their responsibilities
|
|
4
|
+
- Technology choices and rationale
|
|
5
|
+
- Data models and relationships
|
|
6
|
+
- API/interface contracts (inputs, outputs, auth)
|
|
7
|
+
- Major design decisions and trade-offs
|
|
8
|
+
- Non-functional requirements that must be preserved
|
|
9
|
+
|
|
10
|
+
Highlight any inconsistencies, missing sections, or diagrams that need updates.
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
Please review `docs/ai/requirements/feature-{name}.md` and the project-level template `docs/ai/requirements/README.md` to ensure structure and content alignment. Summarize:
|
|
2
|
+
- Core problem statement and affected users
|
|
3
|
+
- Goals, non-goals, and success criteria
|
|
4
|
+
- Primary user stories & critical flows
|
|
5
|
+
- Constraints, assumptions, open questions
|
|
6
|
+
- Any missing sections or deviations from the template
|
|
7
|
+
|
|
8
|
+
Identify gaps or contradictions and suggest clarifications.
|
|
9
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Planning Update Assistant (Claude)
|
|
2
|
+
|
|
3
|
+
Please help me reconcile the current implementation progress with our planning documentation.
|
|
4
|
+
|
|
5
|
+
## Step 1: Gather Context
|
|
6
|
+
Ask me for:
|
|
7
|
+
- Feature/branch name and brief status
|
|
8
|
+
- Tasks completed since last update
|
|
9
|
+
- Any new tasks discovered
|
|
10
|
+
- Current blockers or risks
|
|
11
|
+
- Relevant planning docs (e.g., `docs/ai/planning/feature-{name}.md`)
|
|
12
|
+
|
|
13
|
+
## Step 2: Review Planning Doc
|
|
14
|
+
If a planning doc exists:
|
|
15
|
+
- Summarize existing milestones and task breakdowns
|
|
16
|
+
- Note expected sequencing and dependencies
|
|
17
|
+
- Identify outstanding tasks in the plan
|
|
18
|
+
|
|
19
|
+
## Step 3: Reconcile Progress
|
|
20
|
+
For each planned task:
|
|
21
|
+
- Mark status (done / in progress / blocked / not started)
|
|
22
|
+
- Note actual work completed vs. planned scope
|
|
23
|
+
- Record blockers or changes in approach
|
|
24
|
+
- Identify tasks that were skipped or added
|
|
25
|
+
|
|
26
|
+
## Step 4: Update Task List
|
|
27
|
+
Help me produce an updated checklist such as:
|
|
28
|
+
```
|
|
29
|
+
### Current Status: [Feature Name]
|
|
30
|
+
|
|
31
|
+
#### Done
|
|
32
|
+
- [x] Task A - short note on completion or link to commit/pr
|
|
33
|
+
- [x] Task B
|
|
34
|
+
|
|
35
|
+
#### In Progress
|
|
36
|
+
- [ ] Task C - waiting on [dependency]
|
|
37
|
+
|
|
38
|
+
#### Blocked
|
|
39
|
+
- [ ] Task D - blocked by [issue/owner]
|
|
40
|
+
|
|
41
|
+
#### Newly Discovered Work
|
|
42
|
+
- [ ] Task E - reason discovered
|
|
43
|
+
- [ ] Task F - due by [date]
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Step 5: Next Steps & Priorities
|
|
47
|
+
- Suggest the next 2-3 actionable tasks
|
|
48
|
+
- Highlight risky areas needing attention
|
|
49
|
+
- Recommend coordination (design changes, stakeholder sync, etc.)
|
|
50
|
+
- List documentation updates needed
|
|
51
|
+
|
|
52
|
+
## Step 6: Summary for Planning Doc
|
|
53
|
+
Prepare a summary paragraph to copy into the planning doc, covering:
|
|
54
|
+
- Current state and progress
|
|
55
|
+
- Major risks/blockers
|
|
56
|
+
- Upcoming focus items
|
|
57
|
+
- Any changes to scope or timeline
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
Let me know when you're ready to begin the planning update.
|
|
61
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
Review `docs/ai/testing/feature-{name}.md` and ensure it mirrors the base template before writing tests.
|
|
2
|
+
|
|
3
|
+
## Step 1: Gather Context
|
|
4
|
+
Ask me for:
|
|
5
|
+
- Feature name and branch
|
|
6
|
+
- Summary of what changed (link to design & requirements docs)
|
|
7
|
+
- Target environment (backend, frontend, full-stack)
|
|
8
|
+
- Existing automated test suites (unit, integration, E2E)
|
|
9
|
+
- Any flaky or slow tests to avoid
|
|
10
|
+
|
|
11
|
+
## Step 2: Analyze Testing Template
|
|
12
|
+
- Identify required sections from `docs/ai/testing/feature-{name}.md` (unit, integration, manual verification, coverage targets)
|
|
13
|
+
- Confirm success criteria and edge cases from requirements & design docs
|
|
14
|
+
- Note any mocks/stubs or fixtures already available
|
|
15
|
+
|
|
16
|
+
## Step 3: Unit Tests (Aim for 100% coverage)
|
|
17
|
+
For each module/function:
|
|
18
|
+
1. List behavior scenarios (happy path, edge cases, error handling)
|
|
19
|
+
2. Generate concrete test cases with assertions and inputs
|
|
20
|
+
3. Reference existing utilities/mocks to accelerate implementation
|
|
21
|
+
4. Provide pseudocode or actual test snippets
|
|
22
|
+
5. Highlight potential missing branches preventing full coverage
|
|
23
|
+
|
|
24
|
+
## Step 4: Integration Tests
|
|
25
|
+
1. Identify critical flows that span multiple components/services
|
|
26
|
+
2. Define setup/teardown steps (databases, APIs, queues)
|
|
27
|
+
3. Outline test cases validating interaction boundaries, data contracts, and failure modes
|
|
28
|
+
4. Suggest instrumentation/logging to debug failures
|
|
29
|
+
|
|
30
|
+
## Step 5: Coverage Strategy
|
|
31
|
+
- Recommend tooling commands (e.g., `npm run test -- --coverage`)
|
|
32
|
+
- Call out files/functions that still need coverage and why
|
|
33
|
+
- Suggest additional tests if coverage <100%
|
|
34
|
+
|
|
35
|
+
## Step 6: Manual & Exploratory Testing
|
|
36
|
+
- Propose manual test checklist covering UX, accessibility, and error handling
|
|
37
|
+
- Identify exploratory scenarios or chaos/failure injection tests if relevant
|
|
38
|
+
|
|
39
|
+
## Step 7: Update Documentation & TODOs
|
|
40
|
+
- Summarize which tests were added or still missing
|
|
41
|
+
- Update `docs/ai/testing/feature-{name}.md` sections with links to test files and results
|
|
42
|
+
- Flag follow-up tasks for deferred tests (with owners/dates)
|
|
43
|
+
|
|
44
|
+
Let me know when you have the latest code changes ready; we'll write tests together until we hit 100% coverage.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
Compare the current implementation with the design in docs/ai/design/ and requirements in docs/ai/requirements/. Please follow this structured review:
|
|
2
|
+
|
|
3
|
+
1. Ask me for:
|
|
4
|
+
- Feature/branch description
|
|
5
|
+
- List of modified files
|
|
6
|
+
- Relevant design doc(s) (feature-specific and/or project-level)
|
|
7
|
+
- Any known constraints or assumptions
|
|
8
|
+
|
|
9
|
+
2. For each design doc:
|
|
10
|
+
- Summarize key architectural decisions and constraints
|
|
11
|
+
- Highlight components, interfaces, and data flows that must be respected
|
|
12
|
+
|
|
13
|
+
3. File-by-file comparison:
|
|
14
|
+
- Confirm implementation matches design intent
|
|
15
|
+
- Note deviations or missing pieces
|
|
16
|
+
- Flag logic gaps, edge cases, or security issues
|
|
17
|
+
- Suggest simplifications or refactors
|
|
18
|
+
- Identify missing tests or documentation updates
|
|
19
|
+
|
|
20
|
+
4. Summarize findings with recommended next steps.
|
|
21
|
+
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Local Code Review Assistant
|
|
2
|
+
|
|
3
|
+
You are helping me perform a local code review **before** I push changes. Please follow this structured workflow.
|
|
4
|
+
|
|
5
|
+
## Step 1: Gather Context
|
|
6
|
+
Ask me for:
|
|
7
|
+
- Brief feature/branch description
|
|
8
|
+
- List of modified files (with optional summaries)
|
|
9
|
+
- Relevant design doc(s) (e.g., `docs/ai/design/feature-{name}.md` or project-level design)
|
|
10
|
+
- Any known constraints or risky areas
|
|
11
|
+
- Any open bugs or TODOs linked to this work
|
|
12
|
+
- Which tests have already been run
|
|
13
|
+
|
|
14
|
+
If possible, request the latest diff:
|
|
15
|
+
```bash
|
|
16
|
+
git status -sb
|
|
17
|
+
git diff --stat
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Step 2: Understand Design Alignment
|
|
21
|
+
For each provided design doc:
|
|
22
|
+
- Summarize the architectural intent
|
|
23
|
+
- Note critical requirements, patterns, or constraints the design mandates
|
|
24
|
+
|
|
25
|
+
## Step 3: File-by-File Review
|
|
26
|
+
For every modified file:
|
|
27
|
+
1. Highlight deviations from the referenced design or requirements
|
|
28
|
+
2. Spot potential logic or flow issues and edge cases
|
|
29
|
+
3. Identify redundant or duplicate code
|
|
30
|
+
4. Suggest simplifications or refactors (prefer clarity over cleverness)
|
|
31
|
+
5. Flag security concerns (input validation, secrets, auth, data handling)
|
|
32
|
+
6. Check for performance pitfalls or scalability risks
|
|
33
|
+
7. Ensure error handling, logging, and observability are appropriate
|
|
34
|
+
8. Note any missing comments or docs
|
|
35
|
+
9. Flag missing or outdated tests related to this file
|
|
36
|
+
|
|
37
|
+
## Step 4: Cross-Cutting Concerns
|
|
38
|
+
- Verify naming consistency and adherence to project conventions
|
|
39
|
+
- Confirm documentation/comments are updated where the behavior changed
|
|
40
|
+
- Identify missing tests (unit, integration, E2E) needed to cover the changes
|
|
41
|
+
- Ensure configuration/migration updates are captured if applicable
|
|
42
|
+
|
|
43
|
+
## Step 5: Summarize Findings
|
|
44
|
+
Provide results in this structure:
|
|
45
|
+
```
|
|
46
|
+
### Summary
|
|
47
|
+
- Blocking issues: [count]
|
|
48
|
+
- Important follow-ups: [count]
|
|
49
|
+
- Nice-to-have improvements: [count]
|
|
50
|
+
|
|
51
|
+
### Detailed Notes
|
|
52
|
+
1. **[File or Component]**
|
|
53
|
+
- Issue/Observation: ...
|
|
54
|
+
- Impact: (e.g., blocking / important / nice-to-have)
|
|
55
|
+
- Recommendation: ...
|
|
56
|
+
- Design reference: [...]
|
|
57
|
+
|
|
58
|
+
2. ... (repeat per finding)
|
|
59
|
+
|
|
60
|
+
### Recommended Next Steps
|
|
61
|
+
- [ ] Address blocking issues
|
|
62
|
+
- [ ] Update design/implementation docs if needed
|
|
63
|
+
- [ ] Add/adjust tests:
|
|
64
|
+
- Unit:
|
|
65
|
+
- Integration:
|
|
66
|
+
- E2E:
|
|
67
|
+
- [ ] Rerun local test suite
|
|
68
|
+
- [ ] Re-run code review command after fixes
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Step 6: Final Checklist
|
|
72
|
+
Confirm whether each item is complete (yes/no/needs follow-up):
|
|
73
|
+
- Implementation matches design & requirements
|
|
74
|
+
- No obvious logic or edge-case gaps remain
|
|
75
|
+
- Redundant code removed or justified
|
|
76
|
+
- Security considerations addressed
|
|
77
|
+
- Tests cover new/changed behavior
|
|
78
|
+
- Documentation/design notes updated
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
Let me know when you're ready to begin the review.
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Feature Plan Execution Assistant
|
|
2
|
+
|
|
3
|
+
Help me work through a feature plan one task at a time.
|
|
4
|
+
|
|
5
|
+
## Step 1: Gather Context
|
|
6
|
+
Ask me for:
|
|
7
|
+
- Feature name (kebab-case, e.g., `user-authentication`)
|
|
8
|
+
- Brief feature/branch description
|
|
9
|
+
- Relevant planning doc path (default `docs/ai/planning/feature-{name}.md`)
|
|
10
|
+
- Any supporting design/implementation docs (design, requirements, implementation)
|
|
11
|
+
- Current branch and latest diff summary (`git status -sb`, `git diff --stat`)
|
|
12
|
+
|
|
13
|
+
## Step 2: Load the Plan
|
|
14
|
+
- Request the planning doc contents or offer commands like:
|
|
15
|
+
```bash
|
|
16
|
+
cat docs/ai/planning/feature-<name>.md
|
|
17
|
+
```
|
|
18
|
+
- Parse sections that represent task lists (look for headings + checkboxes `[ ]`, `[x]`).
|
|
19
|
+
- Build an ordered queue of tasks grouped by section (e.g., Foundation, Core Features, Testing).
|
|
20
|
+
|
|
21
|
+
## Step 3: Present Task Queue
|
|
22
|
+
Show an overview:
|
|
23
|
+
```
|
|
24
|
+
### Task Queue: <Feature Name>
|
|
25
|
+
1. [status] Section • Task title
|
|
26
|
+
2. ...
|
|
27
|
+
```
|
|
28
|
+
Status legend: `todo`, `in-progress`, `done`, `blocked` (based on checkbox/notes if present).
|
|
29
|
+
|
|
30
|
+
## Step 4: Interactive Task Execution
|
|
31
|
+
For each task in order:
|
|
32
|
+
1. Display the section/context, full bullet text, and any existing notes.
|
|
33
|
+
2. Suggest relevant docs to reference (requirements/design/implementation).
|
|
34
|
+
3. Ask: "Plan for this task?" Offer to outline sub-steps using the design doc.
|
|
35
|
+
4. Prompt to mark status (`done`, `in-progress`, `blocked`, `skipped`) and capture short notes/next steps.
|
|
36
|
+
5. Encourage code/document edits inside Cursor; offer commands/snippets when useful.
|
|
37
|
+
6. If blocked, record blocker info and move task to the end or into a "Blocked" list.
|
|
38
|
+
|
|
39
|
+
## Step 5: Update Planning Doc
|
|
40
|
+
After each status change, generate a Markdown snippet the user can paste back into the planning doc, e.g.:
|
|
41
|
+
```
|
|
42
|
+
- [x] Task: Implement auth service (Notes: finished POST /auth/login, tests added)
|
|
43
|
+
```
|
|
44
|
+
Remind the user to keep the source doc updated.
|
|
45
|
+
|
|
46
|
+
## Step 6: Check for Newly Discovered Work
|
|
47
|
+
After each section, ask if new tasks were discovered. If yes, capture them in a "New Work" list with status `todo` and include in the summary.
|
|
48
|
+
|
|
49
|
+
## Step 7: Session Summary
|
|
50
|
+
Produce a summary table:
|
|
51
|
+
```
|
|
52
|
+
### Execution Summary
|
|
53
|
+
- Completed: (list)
|
|
54
|
+
- In Progress: (list + owners/next steps)
|
|
55
|
+
- Blocked: (list + blockers)
|
|
56
|
+
- Skipped / Deferred: (list + rationale)
|
|
57
|
+
- New Tasks: (list)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Step 8: Next Actions
|
|
61
|
+
Remind the user to:
|
|
62
|
+
- Update `docs/ai/planning/feature-{name}.md` with the new statuses
|
|
63
|
+
- Sync related docs (requirements/design/implementation/testing) if decisions changed
|
|
64
|
+
- Run `/check-implementation` to validate changes against design docs
|
|
65
|
+
- Run `/writing-test` to produce unit/integration tests targeting 100% coverage
|
|
66
|
+
- Run `/update-planning` to reconcile the planning doc with the latest status
|
|
67
|
+
- Run `/code-review` when ready for final review
|
|
68
|
+
- Run test suites relevant to completed tasks
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
Let me know when you're ready to start executing the plan. Provide the feature name and planning doc first.
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
I want to add a new feature/requirement. Please guide me through the complete development workflow:
|
|
2
|
+
|
|
3
|
+
## Step 1: Capture Requirement
|
|
4
|
+
First, ask me:
|
|
5
|
+
- What is the feature name? (e.g., "user-authentication", "payment-integration")
|
|
6
|
+
- What problem does it solve?
|
|
7
|
+
- Who will use it?
|
|
8
|
+
- What are the key user stories?
|
|
9
|
+
|
|
10
|
+
## Step 2: Create Feature Documentation Structure
|
|
11
|
+
Once I provide the requirement, create the following files (copy the existing template content so sections/frontmatter match exactly):
|
|
12
|
+
- Start from `docs/ai/requirements/README.md` → save as `docs/ai/requirements/feature-{name}.md`
|
|
13
|
+
- Start from `docs/ai/design/README.md` → save as `docs/ai/design/feature-{name}.md`
|
|
14
|
+
- Start from `docs/ai/planning/README.md` → save as `docs/ai/planning/feature-{name}.md`
|
|
15
|
+
- Start from `docs/ai/implementation/README.md` → save as `docs/ai/implementation/feature-{name}.md`
|
|
16
|
+
- Start from `docs/ai/testing/README.md` → save as `docs/ai/testing/feature-{name}.md`
|
|
17
|
+
|
|
18
|
+
Ensure the YAML frontmatter and section headings remain identical to the templates before filling in feature-specific content.
|
|
19
|
+
|
|
20
|
+
## Step 3: Requirements Phase
|
|
21
|
+
Help me fill out `docs/ai/requirements/feature-{name}.md`:
|
|
22
|
+
- Clarify the problem statement
|
|
23
|
+
- Define goals and non-goals
|
|
24
|
+
- Write detailed user stories
|
|
25
|
+
- Establish success criteria
|
|
26
|
+
- Identify constraints and assumptions
|
|
27
|
+
- List open questions
|
|
28
|
+
|
|
29
|
+
## Step 4: Design Phase
|
|
30
|
+
Guide me through `docs/ai/design/feature-{name}.md`:
|
|
31
|
+
- Propose system architecture changes needed
|
|
32
|
+
- Define data models/schema changes
|
|
33
|
+
- Design API endpoints or interfaces
|
|
34
|
+
- Identify components to create/modify
|
|
35
|
+
- Document key design decisions
|
|
36
|
+
- Note security and performance considerations
|
|
37
|
+
|
|
38
|
+
## Step 5: Planning Phase
|
|
39
|
+
Help me break down work in `docs/ai/planning/feature-{name}.md`:
|
|
40
|
+
- Create task breakdown with subtasks
|
|
41
|
+
- Identify dependencies (on other features, APIs, etc.)
|
|
42
|
+
- Estimate effort for each task
|
|
43
|
+
- Suggest implementation order
|
|
44
|
+
- Identify risks and mitigation strategies
|
|
45
|
+
|
|
46
|
+
## Step 6: Documentation Review (Chained Commands)
|
|
47
|
+
Once the docs above are drafted, run the following commands to tighten them up:
|
|
48
|
+
- `/review-requirements` to validate the requirements doc for completeness and clarity
|
|
49
|
+
- `/review-design` to ensure the design doc aligns with requirements and highlights key decisions
|
|
50
|
+
|
|
51
|
+
(If you are using Claude Code, reference the `review-requirements` and `review-design` commands instead.)
|
|
52
|
+
|
|
53
|
+
## Step 7: Implementation Phase (Deferred)
|
|
54
|
+
This command focuses on documentation only. Actual implementation happens later via `/execute-plan`.
|
|
55
|
+
For each task in the plan:
|
|
56
|
+
1. Review the task requirements and design
|
|
57
|
+
2. Ask me to confirm I'm starting this task
|
|
58
|
+
3. Guide implementation with reference to design docs
|
|
59
|
+
4. Suggest code structure and patterns
|
|
60
|
+
5. Help with error handling and edge cases
|
|
61
|
+
6. Update `docs/ai/implementation/feature-{name}.md` with notes
|
|
62
|
+
|
|
63
|
+
## Step 8: Testing Phase
|
|
64
|
+
Guide testing in `docs/ai/testing/feature-{name}.md`:
|
|
65
|
+
- Draft unit test cases with `/writing-test`
|
|
66
|
+
- Draft integration test scenarios with `/writing-test`
|
|
67
|
+
- Recommend manual testing steps
|
|
68
|
+
- Help write test code
|
|
69
|
+
- Verify all success criteria are testable
|
|
70
|
+
|
|
71
|
+
## Step 9: Local Testing & Verification
|
|
72
|
+
Guide me through:
|
|
73
|
+
1. Running all tests locally
|
|
74
|
+
2. Manual testing checklist
|
|
75
|
+
3. Reviewing against requirements
|
|
76
|
+
4. Checking design compliance
|
|
77
|
+
5. Preparing for code review (diff summary, list of files, design references)
|
|
78
|
+
|
|
79
|
+
## Step 10: Local Code Review (Optional but recommended)
|
|
80
|
+
Before pushing, ask me to run `/code-review` with the modified file list and relevant docs.
|
|
81
|
+
|
|
82
|
+
## Step 11: Implementation Execution Reminder
|
|
83
|
+
When ready to implement, run `/execute-plan` to work through the planning doc tasks interactively. That command will orchestrate implementation, testing, and follow-up documentation.
|
|
84
|
+
|
|
85
|
+
## Step 12: Create Merge/Pull Request
|
|
86
|
+
Provide the MR/PR description:
|
|
87
|
+
```markdown
|
|
88
|
+
## Feature: [Feature Name]
|
|
89
|
+
|
|
90
|
+
### Summary
|
|
91
|
+
[Brief description of what this feature does]
|
|
92
|
+
|
|
93
|
+
### Requirements
|
|
94
|
+
- Documented in: `docs/ai/requirements/feature-{name}.md`
|
|
95
|
+
- Related to: [issue/ticket number if applicable]
|
|
96
|
+
|
|
97
|
+
### Changes
|
|
98
|
+
- [List key changes]
|
|
99
|
+
- [List new files/components]
|
|
100
|
+
- [List modified files]
|
|
101
|
+
|
|
102
|
+
### Design
|
|
103
|
+
- Architecture: [Link to design doc section]
|
|
104
|
+
- Key decisions: [Brief summary]
|
|
105
|
+
|
|
106
|
+
### Testing
|
|
107
|
+
- Unit tests: [coverage/status]
|
|
108
|
+
- Integration tests: [status]
|
|
109
|
+
- Manual testing: ✓ Completed
|
|
110
|
+
- Test documentation: `docs/ai/testing/feature-{name}.md`
|
|
111
|
+
|
|
112
|
+
### Checklist
|
|
113
|
+
- [ ] Code follows project standards
|
|
114
|
+
- [ ] All tests pass
|
|
115
|
+
- [ ] Documentation updated
|
|
116
|
+
- [ ] No breaking changes (or documented if any)
|
|
117
|
+
- [ ] Ready for review
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Then provide the appropriate command:
|
|
121
|
+
- **GitHub**: `gh pr create --title "feat: [feature-name]" --body-file pr-description.md`
|
|
122
|
+
- **GitLab**: `glab mr create --title "feat: [feature-name]" --description "$(cat mr-description.md)"`
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
**Let's start! Tell me about the feature you want to build.**
|
|
127
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
Review the design documentation in docs/ai/design/feature-{name}.md (and the project-level README if relevant). Summarize:
|
|
2
|
+
- Architecture overview (ensure mermaid diagram is present and accurate)
|
|
3
|
+
- Key components and their responsibilities
|
|
4
|
+
- Technology choices and rationale
|
|
5
|
+
- Data models and relationships
|
|
6
|
+
- API/interface contracts (inputs, outputs, auth)
|
|
7
|
+
- Major design decisions and trade-offs
|
|
8
|
+
- Non-functional requirements that must be preserved
|
|
9
|
+
|
|
10
|
+
Highlight any inconsistencies, missing sections, or diagrams that need updates.
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
Please review `docs/ai/requirements/feature-{name}.md` and the project-level template `docs/ai/requirements/README.md` to ensure structure and content alignment. Summarize:
|
|
2
|
+
- Core problem statement and affected users
|
|
3
|
+
- Goals, non-goals, and success criteria
|
|
4
|
+
- Primary user stories & critical flows
|
|
5
|
+
- Constraints, assumptions, open questions
|
|
6
|
+
- Any missing sections or deviations from the template
|
|
7
|
+
|
|
8
|
+
Identify gaps or contradictions and suggest clarifications.
|
|
9
|
+
|