bmad-method 4.24.6 → 4.25.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 +12 -0
- package/bmad-core/agents/analyst.md +8 -5
- package/bmad-core/agents/architect.md +7 -5
- package/bmad-core/agents/bmad-master.md +19 -22
- package/bmad-core/agents/dev.md +20 -28
- package/bmad-core/agents/pm.md +6 -4
- package/bmad-core/agents/po.md +11 -7
- package/bmad-core/agents/qa.md +9 -3
- package/bmad-core/agents/sm.md +5 -5
- package/bmad-core/agents/ux-expert.md +6 -11
- package/bmad-core/checklists/story-draft-checklist.md +1 -1
- package/bmad-core/core-config.yaml +1 -1
- package/bmad-core/tasks/create-next-story.md +61 -224
- package/bmad-core/tasks/review-story.md +18 -8
- package/bmad-core/tasks/validate-next-story.md +134 -0
- package/bmad-core/templates/project-brief-tmpl.md +4 -2
- package/bmad-core/templates/story-tmpl.md +22 -33
- package/dist/agents/analyst.txt +10 -6
- package/dist/agents/architect.txt +5 -4
- package/dist/agents/bmad-master.txt +105 -281
- package/dist/agents/dev.txt +155 -26
- package/dist/agents/pm.txt +4 -3
- package/dist/agents/po.txt +168 -39
- package/dist/agents/qa.txt +25 -10
- package/dist/agents/sm.txt +87 -262
- package/dist/agents/ux-expert.txt +4 -10
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +10 -6
- package/dist/teams/team-all.txt +299 -327
- package/dist/teams/team-fullstack.txt +191 -62
- package/dist/teams/team-ide-minimal.txt +276 -304
- package/dist/teams/team-no-ui.txt +187 -52
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-creator-tools/config.yaml +1 -1
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
- package/package.json +1 -1
- package/tools/installer/package.json +1 -1
|
@@ -228,14 +228,16 @@ startup:
|
|
|
228
228
|
- Greet the user with your name and role, and inform of the *help command.
|
|
229
229
|
commands:
|
|
230
230
|
- help: Show numbered list of the following commands to allow selection
|
|
231
|
-
-
|
|
232
|
-
-
|
|
233
|
-
-
|
|
234
|
-
-
|
|
235
|
-
- correct-course: Analyze and suggest project course corrections
|
|
231
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
232
|
+
- execute-checklist {checklist}: Run task execute-checklist (default->po-master-checklist)
|
|
233
|
+
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
|
234
|
+
- correct-course: execute the correct-course task
|
|
236
235
|
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
|
|
237
236
|
- create-story: Create user story from requirements (task brownfield-create-story)
|
|
238
|
-
-
|
|
237
|
+
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
|
238
|
+
- doc-out: Output full document to current destination file
|
|
239
|
+
- validate-story-draft {story}: run the task validate-next-story against the provided story file
|
|
240
|
+
- exit: Exit (confirm)
|
|
239
241
|
dependencies:
|
|
240
242
|
tasks:
|
|
241
243
|
- execute-checklist
|
|
@@ -243,6 +245,7 @@ dependencies:
|
|
|
243
245
|
- correct-course
|
|
244
246
|
- brownfield-create-epic
|
|
245
247
|
- brownfield-create-story
|
|
248
|
+
- validate-next-story
|
|
246
249
|
templates:
|
|
247
250
|
- story-tmpl
|
|
248
251
|
checklists:
|
|
@@ -285,10 +288,9 @@ startup:
|
|
|
285
288
|
- Only execute tasks when user explicitly requests them
|
|
286
289
|
commands:
|
|
287
290
|
- help: Show numbered list of the following commands to allow selection
|
|
288
|
-
-
|
|
289
|
-
-
|
|
290
|
-
-
|
|
291
|
-
- checklist {checklist}: Show numbered list of checklists, execute selection
|
|
291
|
+
- draft: Execute task create-next-story
|
|
292
|
+
- correct-course: Execute task correct-course
|
|
293
|
+
- checklist {checklist}: Show numbered list of checklists if not provided, execute task execute-checklist
|
|
292
294
|
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
|
|
293
295
|
dependencies:
|
|
294
296
|
tasks:
|
|
@@ -319,45 +321,37 @@ agent:
|
|
|
319
321
|
customization: null
|
|
320
322
|
startup:
|
|
321
323
|
- Announce: Greet the user with your name and role, and inform of the *help command.
|
|
322
|
-
- CRITICAL:
|
|
323
|
-
- CRITICAL:
|
|
324
|
-
- CRITICAL: Do NOT
|
|
325
|
-
- CRITICAL: Do NOT begin development until told to proceed
|
|
324
|
+
- CRITICAL: Read the following full files as these are your explicit rules for development standards for this project - {root}/core-config.yaml devLoadAlwaysFiles list
|
|
325
|
+
- CRITICAL: Do NOT load any other files during startup aside from the assigned story and devLoadAlwaysFiles items, unless user requested you do or the following contradicts
|
|
326
|
+
- CRITICAL: Do NOT begin development until a story is not in draft mode and you are told to proceed
|
|
326
327
|
persona:
|
|
327
328
|
role: Expert Senior Software Engineer & Implementation Specialist
|
|
328
329
|
style: Extremely concise, pragmatic, detail-oriented, solution-focused
|
|
329
330
|
identity: Expert who implements stories by reading requirements and executing tasks sequentially with comprehensive testing
|
|
330
331
|
focus: Executing story tasks with precision, updating Dev Agent Record sections only, maintaining minimal context overhead
|
|
331
332
|
core_principles:
|
|
332
|
-
- CRITICAL: Story
|
|
333
|
-
- CRITICAL:
|
|
334
|
-
-
|
|
335
|
-
-
|
|
336
|
-
- Quality Gate Discipline - NEVER complete tasks with failing automated validations
|
|
337
|
-
- Debug Log Discipline - Log temp changes to md table in devDebugLog. Revert after fix.
|
|
338
|
-
- Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
|
|
339
|
-
- Code Excellence - Clean, secure, maintainable code per loaded standards
|
|
340
|
-
- Numbered Options - Always use numbered lists when presenting choices
|
|
333
|
+
- CRITICAL: Story has ALL info you will need aside from what you loaded during the startup commands. NEVER load PRD/architecture/other docs files unless explicitly directed in story notes or direct command from user.
|
|
334
|
+
- CRITICAL: ONLY update story file Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
|
|
335
|
+
- CRITICAL: FOLLOW THE develop-story command when the user tells you to implement the story
|
|
336
|
+
- Numbered Options - Always use numbered lists when presenting choices to the user
|
|
341
337
|
commands:
|
|
342
338
|
- help: Show numbered list of the following commands to allow selection
|
|
343
339
|
- run-tests: Execute linting and tests
|
|
344
|
-
-
|
|
345
|
-
- complete-story: Finalize to "Review"
|
|
340
|
+
- explain: teach me what and why you did whatever you just did in detail so I can learn. Explain to me as if you were training a junior engineer.
|
|
346
341
|
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
updates-ONLY:
|
|
350
|
-
-
|
|
351
|
-
-
|
|
352
|
-
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
done: Code matches reqs + All validations pass + Follows standards + File List complete
|
|
357
|
-
completion: All [x]→Validations pass→Integration(if noted)→E2E(if noted)→DoD→Update File List→Mark Ready for Review→HALT
|
|
342
|
+
develop-story:
|
|
343
|
+
order-of-execution: Read (first or next) task→Implement Task and its subtasks→Write tests→Execute validations→Only if ALL pass, then update the task checkbox with [x]→Update story section File List to ensure it lists and new or modified or deleted source file→repeat order-of-execution until complete
|
|
344
|
+
story-file-updates-ONLY:
|
|
345
|
+
- CRITICAL: ONLY UPDATE THE STORY FILE WITH UPDATES TO SECTIONS INDICATED BELOW. DO NOT MODIFY ANY OTHER SECTIONS.
|
|
346
|
+
- CRITICAL: You are ONLY authorized to edit these specific sections of story files - Tasks / Subtasks Checkboxes, Dev Agent Record section and all its subsections, Agent Model Used, Debug Log References, Completion Notes List, File List, Change Log, Status
|
|
347
|
+
- CRITICAL: DO NOT modify Status, Story, Acceptance Criteria, Dev Notes, Testing sections, or any other sections not listed above
|
|
348
|
+
blocking: 'HALT for: Unapproved deps needed, confirm with user | Ambiguous after story check | 3 failures attempting to implement or fix something repeatedly | Missing config | Failing regression'
|
|
349
|
+
ready-for-review: Code matches requirements + All validations pass + Follows standards + File List complete
|
|
350
|
+
completion: 'All Tasks and Subtasks marked [x] and have tests→Validations and full regression passes (DON''T BE LAZY, EXECUTE ALL TESTS and CONFIRM)→Ensure File List is Complete→run the task execute-checklist for the checklist story-dod-checklist→set story status: ''Ready for Review''→HALT'
|
|
358
351
|
dependencies:
|
|
359
352
|
tasks:
|
|
360
353
|
- execute-checklist
|
|
354
|
+
- validate-next-story
|
|
361
355
|
checklists:
|
|
362
356
|
- story-dod-checklist
|
|
363
357
|
```
|
|
@@ -399,10 +393,15 @@ persona:
|
|
|
399
393
|
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
|
400
394
|
startup:
|
|
401
395
|
- Greet the user with your name and role, and inform of the *help command.
|
|
396
|
+
story-file-permissions:
|
|
397
|
+
- CRITICAL: When reviewing stories, you are ONLY authorized to update the "QA Results" section of story files
|
|
398
|
+
- CRITICAL: DO NOT modify any other sections including Status, Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Testing, Dev Agent Record, Change Log, or any other sections
|
|
399
|
+
- CRITICAL: Your updates must be limited to appending your review results in the QA Results section only
|
|
402
400
|
commands:
|
|
403
401
|
- help: Show numbered list of the following commands to allow selection
|
|
404
|
-
-
|
|
405
|
-
-
|
|
402
|
+
- review {story}: execute the task review-story for the highest sequence story in docs/stories unless another is specified - keep any specified technical-preferences in mind as needed
|
|
403
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
404
|
+
- exit: Say goodbye as the QA Engineer, and then abandon inhabiting this persona
|
|
406
405
|
dependencies:
|
|
407
406
|
tasks:
|
|
408
407
|
- review-story
|
|
@@ -2976,18 +2975,170 @@ The story creation is successful when:
|
|
|
2976
2975
|
- Stories should take no more than 4 hours of focused development work
|
|
2977
2976
|
==================== END: tasks#brownfield-create-story ====================
|
|
2978
2977
|
|
|
2978
|
+
==================== START: tasks#validate-next-story ====================
|
|
2979
|
+
# Validate Next Story Task
|
|
2980
|
+
|
|
2981
|
+
## Purpose
|
|
2982
|
+
|
|
2983
|
+
To comprehensively validate a story draft before implementation begins, ensuring it is complete, accurate, and provides sufficient context for successful development. This task identifies issues and gaps that need to be addressed, preventing hallucinations and ensuring implementation readiness.
|
|
2984
|
+
|
|
2985
|
+
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
2986
|
+
|
|
2987
|
+
### 0. Load Core Configuration and Inputs
|
|
2988
|
+
|
|
2989
|
+
- Load `.bmad-core/core-config.yaml` from the project root
|
|
2990
|
+
- If the file does not exist, HALT and inform the user: "core-config.yaml not found. This file is required for story validation."
|
|
2991
|
+
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`
|
|
2992
|
+
- Identify and load the following inputs:
|
|
2993
|
+
- **Story file**: The drafted story to validate (provided by user or discovered in `devStoryLocation`)
|
|
2994
|
+
- **Parent epic**: The epic containing this story's requirements
|
|
2995
|
+
- **Architecture documents**: Based on configuration (sharded or monolithic)
|
|
2996
|
+
- **Story template**: `bmad-core/templates/story-tmpl.md` for completeness validation
|
|
2997
|
+
|
|
2998
|
+
### 1. Template Completeness Validation
|
|
2999
|
+
|
|
3000
|
+
- Load `bmad-core/templates/story-tmpl.md` and extract all section headings from the template
|
|
3001
|
+
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
|
|
3002
|
+
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
|
|
3003
|
+
- **Agent section verification**: Confirm all sections from template exist for future agent use
|
|
3004
|
+
- **Structure compliance**: Verify story follows template structure and formatting
|
|
3005
|
+
|
|
3006
|
+
### 2. File Structure and Source Tree Validation
|
|
3007
|
+
|
|
3008
|
+
- **File paths clarity**: Are new/existing files to be created/modified clearly specified?
|
|
3009
|
+
- **Source tree relevance**: Is relevant project structure included in Dev Notes?
|
|
3010
|
+
- **Directory structure**: Are new directories/components properly located according to project structure?
|
|
3011
|
+
- **File creation sequence**: Do tasks specify where files should be created in logical order?
|
|
3012
|
+
- **Path accuracy**: Are file paths consistent with project structure from architecture docs?
|
|
3013
|
+
|
|
3014
|
+
### 3. UI/Frontend Completeness Validation (if applicable)
|
|
3015
|
+
|
|
3016
|
+
- **Component specifications**: Are UI components sufficiently detailed for implementation?
|
|
3017
|
+
- **Styling/design guidance**: Is visual implementation guidance clear?
|
|
3018
|
+
- **User interaction flows**: Are UX patterns and behaviors specified?
|
|
3019
|
+
- **Responsive/accessibility**: Are these considerations addressed if required?
|
|
3020
|
+
- **Integration points**: Are frontend-backend integration points clear?
|
|
3021
|
+
|
|
3022
|
+
### 4. Acceptance Criteria Satisfaction Assessment
|
|
3023
|
+
|
|
3024
|
+
- **AC coverage**: Will all acceptance criteria be satisfied by the listed tasks?
|
|
3025
|
+
- **AC testability**: Are acceptance criteria measurable and verifiable?
|
|
3026
|
+
- **Missing scenarios**: Are edge cases or error conditions covered?
|
|
3027
|
+
- **Success definition**: Is "done" clearly defined for each AC?
|
|
3028
|
+
- **Task-AC mapping**: Are tasks properly linked to specific acceptance criteria?
|
|
3029
|
+
|
|
3030
|
+
### 5. Validation and Testing Instructions Review
|
|
3031
|
+
|
|
3032
|
+
- **Test approach clarity**: Are testing methods clearly specified?
|
|
3033
|
+
- **Test scenarios**: Are key test cases identified?
|
|
3034
|
+
- **Validation steps**: Are acceptance criteria validation steps clear?
|
|
3035
|
+
- **Testing tools/frameworks**: Are required testing tools specified?
|
|
3036
|
+
- **Test data requirements**: Are test data needs identified?
|
|
3037
|
+
|
|
3038
|
+
### 6. Security Considerations Assessment (if applicable)
|
|
3039
|
+
|
|
3040
|
+
- **Security requirements**: Are security needs identified and addressed?
|
|
3041
|
+
- **Authentication/authorization**: Are access controls specified?
|
|
3042
|
+
- **Data protection**: Are sensitive data handling requirements clear?
|
|
3043
|
+
- **Vulnerability prevention**: Are common security issues addressed?
|
|
3044
|
+
- **Compliance requirements**: Are regulatory/compliance needs addressed?
|
|
3045
|
+
|
|
3046
|
+
### 7. Tasks/Subtasks Sequence Validation
|
|
3047
|
+
|
|
3048
|
+
- **Logical order**: Do tasks follow proper implementation sequence?
|
|
3049
|
+
- **Dependencies**: Are task dependencies clear and correct?
|
|
3050
|
+
- **Granularity**: Are tasks appropriately sized and actionable?
|
|
3051
|
+
- **Completeness**: Do tasks cover all requirements and acceptance criteria?
|
|
3052
|
+
- **Blocking issues**: Are there any tasks that would block others?
|
|
3053
|
+
|
|
3054
|
+
### 8. Anti-Hallucination Verification
|
|
3055
|
+
|
|
3056
|
+
- **Source verification**: Every technical claim must be traceable to source documents
|
|
3057
|
+
- **Architecture alignment**: Dev Notes content matches architecture specifications
|
|
3058
|
+
- **No invented details**: Flag any technical decisions not supported by source documents
|
|
3059
|
+
- **Reference accuracy**: Verify all source references are correct and accessible
|
|
3060
|
+
- **Fact checking**: Cross-reference claims against epic and architecture documents
|
|
3061
|
+
|
|
3062
|
+
### 9. Dev Agent Implementation Readiness
|
|
3063
|
+
|
|
3064
|
+
- **Self-contained context**: Can the story be implemented without reading external docs?
|
|
3065
|
+
- **Clear instructions**: Are implementation steps unambiguous?
|
|
3066
|
+
- **Complete technical context**: Are all required technical details present in Dev Notes?
|
|
3067
|
+
- **Missing information**: Identify any critical information gaps
|
|
3068
|
+
- **Actionability**: Are all tasks actionable by a development agent?
|
|
3069
|
+
|
|
3070
|
+
### 10. Generate Validation Report
|
|
3071
|
+
|
|
3072
|
+
Provide a structured validation report including:
|
|
3073
|
+
|
|
3074
|
+
#### Template Compliance Issues
|
|
3075
|
+
|
|
3076
|
+
- Missing sections from story template
|
|
3077
|
+
- Unfilled placeholders or template variables
|
|
3078
|
+
- Structural formatting issues
|
|
3079
|
+
|
|
3080
|
+
#### Critical Issues (Must Fix - Story Blocked)
|
|
3081
|
+
|
|
3082
|
+
- Missing essential information for implementation
|
|
3083
|
+
- Inaccurate or unverifiable technical claims
|
|
3084
|
+
- Incomplete acceptance criteria coverage
|
|
3085
|
+
- Missing required sections
|
|
3086
|
+
|
|
3087
|
+
#### Should-Fix Issues (Important Quality Improvements)
|
|
3088
|
+
|
|
3089
|
+
- Unclear implementation guidance
|
|
3090
|
+
- Missing security considerations
|
|
3091
|
+
- Task sequencing problems
|
|
3092
|
+
- Incomplete testing instructions
|
|
3093
|
+
|
|
3094
|
+
#### Nice-to-Have Improvements (Optional Enhancements)
|
|
3095
|
+
|
|
3096
|
+
- Additional context that would help implementation
|
|
3097
|
+
- Clarifications that would improve efficiency
|
|
3098
|
+
- Documentation improvements
|
|
3099
|
+
|
|
3100
|
+
#### Anti-Hallucination Findings
|
|
3101
|
+
|
|
3102
|
+
- Unverifiable technical claims
|
|
3103
|
+
- Missing source references
|
|
3104
|
+
- Inconsistencies with architecture documents
|
|
3105
|
+
- Invented libraries, patterns, or standards
|
|
3106
|
+
|
|
3107
|
+
#### Final Assessment
|
|
3108
|
+
|
|
3109
|
+
- **GO**: Story is ready for implementation
|
|
3110
|
+
- **NO-GO**: Story requires fixes before implementation
|
|
3111
|
+
- **Implementation Readiness Score**: 1-10 scale
|
|
3112
|
+
- **Confidence Level**: High/Medium/Low for successful implementation
|
|
3113
|
+
==================== END: tasks#validate-next-story ====================
|
|
3114
|
+
|
|
2979
3115
|
==================== START: templates#story-tmpl ====================
|
|
3116
|
+
---
|
|
3117
|
+
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
|
3118
|
+
smAgent:
|
|
3119
|
+
editableSections: Status, Story, Acceptance Criteria, Tasks / Subtasks, Dev Notes, Testing, Change Log
|
|
3120
|
+
sectionSpecificInstructions:
|
|
3121
|
+
"Dev Notes":
|
|
3122
|
+
- Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story
|
|
3123
|
+
- Do not invent information.
|
|
3124
|
+
- If known add Relevant Source Tree info that relates to this story.
|
|
3125
|
+
- If there were important notes from previous story that are relevant to this one, include them here.
|
|
3126
|
+
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks.
|
|
3127
|
+
Testing:
|
|
3128
|
+
- List Relevant Testing Standards from Architecture the Developer needs to conform to (test file location, test standards, etc)
|
|
3129
|
+
---
|
|
3130
|
+
|
|
2980
3131
|
# Story {{EpicNum}}.{{StoryNum}}: {{Short Title Copied from Epic File specific story}}
|
|
2981
3132
|
|
|
2982
3133
|
## Status: {{ Draft | Approved | InProgress | Review | Done }}
|
|
2983
3134
|
|
|
2984
3135
|
## Story
|
|
2985
3136
|
|
|
2986
|
-
|
|
2987
|
-
|
|
2988
|
-
|
|
3137
|
+
**As a** {{role}},\
|
|
3138
|
+
**I want** {{action}},\
|
|
3139
|
+
**so that** {{benefit}}
|
|
2989
3140
|
|
|
2990
|
-
## Acceptance Criteria
|
|
3141
|
+
## Acceptance Criteria
|
|
2991
3142
|
|
|
2992
3143
|
{{ Copy of Acceptance Criteria numbered list }}
|
|
2993
3144
|
|
|
@@ -3002,20 +3153,12 @@ The story creation is successful when:
|
|
|
3002
3153
|
|
|
3003
3154
|
## Dev Notes
|
|
3004
3155
|
|
|
3005
|
-
[[LLM: populates relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story. Do not invent information. Critical: If known add Relevant Source Tree info that relates to this story. If there were important notes from previous story that are relevant to this one, also include them here if it will help the dev agent. You do NOT need to repeat anything from coding standards or test standards as the dev agent is already aware of those. The dev agent should NEVER need to read the PRD or architecture documents or child documents though to complete this self contained story, because your critical mission is to share the specific items needed here extremely concisely for the Dev Agent LLM to comprehend with the least about of context overhead token usage needed.]]
|
|
3006
|
-
|
|
3007
3156
|
### Testing
|
|
3008
3157
|
|
|
3009
|
-
|
|
3010
|
-
Dev Note: Story Requires the following tests:
|
|
3158
|
+
## Change Log
|
|
3011
3159
|
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
- [ ] {{type f.e. Cypress}} E2E: location: {{f.e. `/e2e/{epic-name/bar.test.ts`}}
|
|
3015
|
-
|
|
3016
|
-
Manual Test Steps: [[LLM: Include how if possible the user can manually test the functionality when story is Ready for Review, if any]]
|
|
3017
|
-
|
|
3018
|
-
{{ f.e. `- dev will create a script with task 3 above that you can run with "npm run test-initiate-launch-sequence" and validate Armageddon is initiated`}}
|
|
3160
|
+
| Date | Version | Description | Author |
|
|
3161
|
+
| :--- | :------ | :---------- | :----- |
|
|
3019
3162
|
|
|
3020
3163
|
## Dev Agent Record
|
|
3021
3164
|
|
|
@@ -3023,29 +3166,11 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
|
|
3023
3166
|
|
|
3024
3167
|
### Debug Log References
|
|
3025
3168
|
|
|
3026
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update]]
|
|
3027
|
-
[[LLM: (Dev Agent) If the debug is logged to during the current story progress, create a table with the debug log and the specific task section in the debug log - do not repeat all the details in the story]]
|
|
3028
|
-
|
|
3029
3169
|
### Completion Notes List
|
|
3030
3170
|
|
|
3031
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
|
3032
|
-
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
|
3033
|
-
|
|
3034
3171
|
### File List
|
|
3035
3172
|
|
|
3036
|
-
[[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
|
|
3037
|
-
|
|
3038
|
-
### Change Log
|
|
3039
|
-
|
|
3040
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
|
3041
|
-
[[LLM: (Dev Agent) Track document versions and changes during development that deviate from story dev start]]
|
|
3042
|
-
|
|
3043
|
-
| Date | Version | Description | Author |
|
|
3044
|
-
| :--- | :------ | :---------- | :----- |
|
|
3045
|
-
|
|
3046
3173
|
## QA Results
|
|
3047
|
-
|
|
3048
|
-
[[LLM: QA Agent Results]]
|
|
3049
3174
|
==================== END: templates#story-tmpl ====================
|
|
3050
3175
|
|
|
3051
3176
|
==================== START: checklists#po-master-checklist ====================
|
|
@@ -3682,187 +3807,62 @@ Keep it action-oriented and forward-looking.]]
|
|
|
3682
3807
|
|
|
3683
3808
|
## Purpose
|
|
3684
3809
|
|
|
3685
|
-
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research.
|
|
3810
|
+
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research or finding its own context.
|
|
3686
3811
|
|
|
3687
|
-
## Task Execution
|
|
3812
|
+
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
3688
3813
|
|
|
3689
|
-
### 0. Load Core Configuration
|
|
3690
|
-
|
|
3691
|
-
[[LLM: CRITICAL - This MUST be your first step]]
|
|
3814
|
+
### 0. Load Core Configuration and Check Workflow
|
|
3692
3815
|
|
|
3693
3816
|
- Load `.bmad-core/core-config.yaml` from the project root
|
|
3694
|
-
- If the file does not exist:
|
|
3695
|
-
|
|
3696
|
-
|
|
3697
|
-
2. Run the BMad installer against your project to upgrade and add the file automatically
|
|
3698
|
-
Please add and configure core-config.yaml before proceeding."
|
|
3699
|
-
- Extract the following key configurations:
|
|
3700
|
-
- `devStoryLocation`: Where to save story files
|
|
3701
|
-
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
|
3702
|
-
- `prd.prdFile`: Location of monolithic PRD (if not sharded)
|
|
3703
|
-
- `prd.prdShardedLocation`: Location of sharded epic files
|
|
3704
|
-
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
|
3705
|
-
- `architecture.architectureVersion`: Architecture document version
|
|
3706
|
-
- `architecture.architectureSharded`: Whether architecture is sharded
|
|
3707
|
-
- `architecture.architectureFile`: Location of monolithic architecture
|
|
3708
|
-
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
|
3709
|
-
- `workflow.trackProgress`: Whether workflow plan tracking is enabled
|
|
3710
|
-
- `workflow.planFile`: Location of workflow plan (if tracking enabled)
|
|
3711
|
-
|
|
3712
|
-
### 0.5 Check Workflow Plan (if configured)
|
|
3713
|
-
|
|
3714
|
-
[[LLM: Check if workflow plan tracking is enabled]]
|
|
3715
|
-
|
|
3716
|
-
- If `workflow.trackProgress: true`, check for active plan at `workflow.planFile`
|
|
3717
|
-
- If plan exists:
|
|
3718
|
-
- Parse plan to check if story creation is the expected next step
|
|
3719
|
-
- If out of sequence and `workflow.enforceSequence: true`:
|
|
3720
|
-
- Show warning: "The workflow plan indicates you should complete {expected_step} before creating stories."
|
|
3721
|
-
- Block execution unless user explicitly overrides
|
|
3722
|
-
- If out of sequence and `workflow.enforceSequence: false`:
|
|
3723
|
-
- Show warning but allow continuation with confirmation
|
|
3724
|
-
- Continue with story identification after plan check
|
|
3817
|
+
- If the file does not exist, HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can either: 1) Copy it from GITHUB bmad-core/core-config.yaml and configure it for your project OR 2) Run the BMad installer against your project to upgrade and add the file automatically. Please add and configure core-config.yaml before proceeding."
|
|
3818
|
+
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`, `workflow.*`
|
|
3819
|
+
- If `workflow.trackProgress: true`, use `utils/plan-management.md` to check plan sequence and warn if out of order
|
|
3725
3820
|
|
|
3726
3821
|
### 1. Identify Next Story for Preparation
|
|
3727
3822
|
|
|
3728
|
-
#### 1.1 Locate Epic Files
|
|
3729
|
-
|
|
3730
|
-
- Based on `prdSharded` from config:
|
|
3731
|
-
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
|
3732
|
-
- **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
|
|
3733
|
-
|
|
3734
|
-
#### 1.2 Review Existing Stories
|
|
3735
|
-
|
|
3736
|
-
- Check `devStoryLocation` from config (e.g., `docs/stories/`) for existing story files
|
|
3737
|
-
- If the directory exists and has at least 1 file, find the highest-numbered story file.
|
|
3738
|
-
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
|
|
3739
|
-
- Verify its `Status` is 'Done' (or equivalent).
|
|
3740
|
-
- If not 'Done', present an alert to the user:
|
|
3741
|
-
|
|
3742
|
-
```plaintext
|
|
3743
|
-
ALERT: Found incomplete story:
|
|
3744
|
-
File: {lastEpicNum}.{lastStoryNum}.story.md
|
|
3745
|
-
Status: [current status]
|
|
3746
|
-
|
|
3747
|
-
Would you like to:
|
|
3748
|
-
1. View the incomplete story details (instructs user to do so, agent does not display)
|
|
3749
|
-
2. Cancel new story creation at this time
|
|
3750
|
-
3. Accept risk & Override to create the next story in draft
|
|
3751
|
-
|
|
3752
|
-
Please choose an option (1/2/3):
|
|
3753
|
-
```
|
|
3754
|
-
|
|
3755
|
-
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
|
|
3756
|
-
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and parse it to find ALL stories in that epic. **ALWAYS select the next sequential story** (e.g., if last was 2.2, next MUST be 2.3).
|
|
3757
|
-
- If the next sequential story has unmet prerequisites, present this to the user:
|
|
3758
|
-
|
|
3759
|
-
```plaintext
|
|
3760
|
-
ALERT: Next story has unmet prerequisites:
|
|
3761
|
-
Story: {epicNum}.{storyNum} - {Story Title}
|
|
3762
|
-
Prerequisites not met: [list specific prerequisites]
|
|
3763
|
-
|
|
3764
|
-
Would you like to:
|
|
3765
|
-
1. Create the story anyway (mark prerequisites as pending)
|
|
3766
|
-
2. Skip to a different story (requires your specific instruction)
|
|
3767
|
-
3. Cancel story creation
|
|
3768
|
-
|
|
3769
|
-
Please choose an option (1/2/3):
|
|
3770
|
-
```
|
|
3771
|
-
|
|
3772
|
-
- If there are no more stories in the current epic (e.g., 2.9 was done and there is no 2.10):
|
|
3773
|
-
|
|
3774
|
-
```plaintext
|
|
3775
|
-
Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed.
|
|
3776
|
-
|
|
3777
|
-
Would you like to:
|
|
3778
|
-
1. Begin Epic {epicNum + 1} with story {epicNum + 1}.1
|
|
3779
|
-
2. Select a specific story to work on
|
|
3780
|
-
3. Cancel story creation
|
|
3781
|
-
|
|
3782
|
-
Please choose an option (1/2/3):
|
|
3783
|
-
```
|
|
3784
|
-
|
|
3785
|
-
- **CRITICAL**: NEVER automatically skip to another epic or non-sequential story. The user MUST explicitly instruct which story to create if skipping the sequential order.
|
|
3786
|
-
|
|
3787
|
-
- **If no story files exist in `docs/stories/`:**
|
|
3788
|
-
- The next story is ALWAYS 1.1 (the first story of the first epic).
|
|
3789
|
-
- If story 1.1 has unmet prerequisites, follow the same alert process as above.
|
|
3790
|
-
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
|
|
3823
|
+
#### 1.1 Locate Epic Files and Review Existing Stories
|
|
3791
3824
|
|
|
3792
|
-
|
|
3825
|
+
- Based on `prdSharded` from config, locate epic files (sharded location/pattern or monolithic PRD sections)
|
|
3826
|
+
- If `devStoryLocation` has story files, load the highest `{epicNum}.{storyNum}.story.md` file
|
|
3827
|
+
- **If highest story exists:**
|
|
3828
|
+
- Verify status is 'Done'. If not, alert user: "ALERT: Found incomplete story! File: {lastEpicNum}.{lastStoryNum}.story.md Status: [current status] You should fix this story first, but would you like to accept risk & override to create the next story in draft?"
|
|
3829
|
+
- If proceeding, select next sequential story in the current epic
|
|
3830
|
+
- If epic is complete, prompt user: "Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed. Would you like to: 1) Begin Epic {epicNum + 1} with story 1 2) Select a specific story to work on 3) Cancel story creation"
|
|
3831
|
+
- **CRITICAL**: NEVER automatically skip to another epic. User MUST explicitly instruct which story to create.
|
|
3832
|
+
- **If no story files exist:** The next story is ALWAYS 1.1 (first story of first epic)
|
|
3833
|
+
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}"
|
|
3793
3834
|
|
|
3794
|
-
|
|
3795
|
-
- Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
|
|
3796
|
-
- Keep a record of this original epic-defined scope for later deviation analysis.
|
|
3835
|
+
### 2. Gather Story Requirements and Previous Story Context
|
|
3797
3836
|
|
|
3798
|
-
|
|
3837
|
+
- Extract story requirements from the identified epic file
|
|
3838
|
+
- If previous story exists, review Dev Agent Record sections for:
|
|
3839
|
+
- Completion Notes and Debug Log References
|
|
3840
|
+
- Implementation deviations and technical decisions
|
|
3841
|
+
- Challenges encountered and lessons learned
|
|
3842
|
+
- Extract relevant insights that inform the current story's preparation
|
|
3799
3843
|
|
|
3800
|
-
|
|
3844
|
+
### 3. Gather Architecture Context
|
|
3801
3845
|
|
|
3802
|
-
|
|
3803
|
-
- Read the previous sequential story from `docs/stories`
|
|
3804
|
-
- Pay special attention to:
|
|
3805
|
-
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
|
|
3806
|
-
- Any deviations from planned implementation
|
|
3807
|
-
- Technical decisions made during implementation
|
|
3808
|
-
- Challenges encountered and solutions applied
|
|
3809
|
-
- Any "lessons learned" or notes for future stories
|
|
3810
|
-
- Extract relevant insights that might inform the current story's preparation
|
|
3846
|
+
#### 3.1 Determine Architecture Reading Strategy
|
|
3811
3847
|
|
|
3812
|
-
|
|
3848
|
+
- **If `architectureVersion: >= v4` and `architectureSharded: true`**: Read `{architectureShardedLocation}/index.md` then follow structured reading order below
|
|
3849
|
+
- **Else**: Use monolithic `architectureFile` for similar sections
|
|
3813
3850
|
|
|
3814
|
-
|
|
3851
|
+
#### 3.2 Read Architecture Documents Based on Story Type
|
|
3815
3852
|
|
|
3816
|
-
|
|
3853
|
+
**For ALL Stories:** tech-stack.md, unified-project-structure.md, coding-standards.md, testing-strategy.md
|
|
3817
3854
|
|
|
3818
|
-
|
|
3855
|
+
**For Backend/API Stories, additionally:** data-models.md, database-schema.md, backend-architecture.md, rest-api-spec.md, external-apis.md
|
|
3819
3856
|
|
|
3820
|
-
|
|
3821
|
-
- Read `{architectureShardedLocation}/index.md` to understand available documentation
|
|
3822
|
-
- Follow the structured reading order in section 4.2 below
|
|
3823
|
-
|
|
3824
|
-
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
|
3825
|
-
- Load the monolithic architecture from `architectureFile`
|
|
3826
|
-
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
|
3827
|
-
|
|
3828
|
-
- **If `architectureVersion` is NOT v4**:
|
|
3829
|
-
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
|
3830
|
-
- If `architectureSharded: true`: Search sharded files by filename relevance
|
|
3831
|
-
- If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
|
|
3857
|
+
**For Frontend/UI Stories, additionally:** frontend-architecture.md, components.md, core-workflows.md, data-models.md
|
|
3832
3858
|
|
|
3833
|
-
|
|
3834
|
-
|
|
3835
|
-
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
|
|
3836
|
-
|
|
3837
|
-
**For ALL Stories:**
|
|
3838
|
-
|
|
3839
|
-
1. `docs/architecture/tech-stack.md` - Understand technology constraints and versions
|
|
3840
|
-
2. `docs/architecture/unified-project-structure.md` - Know where code should be placed
|
|
3841
|
-
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
|
|
3842
|
-
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
|
|
3843
|
-
|
|
3844
|
-
**For Backend/API Stories, additionally read:**
|
|
3845
|
-
5. `docs/architecture/data-models.md` - Data structures and validation rules
|
|
3846
|
-
6. `docs/architecture/database-schema.md` - Database design and relationships
|
|
3847
|
-
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
|
|
3848
|
-
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
|
|
3849
|
-
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
|
|
3859
|
+
**For Full-Stack Stories:** Read both Backend and Frontend sections above
|
|
3850
3860
|
|
|
3851
|
-
|
|
3852
|
-
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
|
|
3853
|
-
6. `docs/architecture/components.md` - Specific component designs
|
|
3854
|
-
7. `docs/architecture/core-workflows.md` - User interaction flows
|
|
3855
|
-
8. `docs/architecture/data-models.md` - Frontend data handling
|
|
3861
|
+
#### 3.3 Extract Story-Specific Technical Details
|
|
3856
3862
|
|
|
3857
|
-
|
|
3863
|
+
Extract ONLY information directly relevant to implementing the current story. Do NOT invent new libraries, patterns, or standards not in the source documents.
|
|
3858
3864
|
|
|
3859
|
-
|
|
3860
|
-
|
|
3861
|
-
#### 4.3 Extract Story-Specific Technical Details
|
|
3862
|
-
|
|
3863
|
-
[[LLM: As you read each document, extract ONLY the information directly relevant to implementing the current story. Do NOT include general information unless it directly impacts the story implementation.]]
|
|
3864
|
-
|
|
3865
|
-
For each relevant document, extract:
|
|
3865
|
+
Extract:
|
|
3866
3866
|
|
|
3867
3867
|
- Specific data models, schemas, or structures the story will use
|
|
3868
3868
|
- API endpoints the story must implement or consume
|
|
@@ -3871,33 +3871,22 @@ For each relevant document, extract:
|
|
|
3871
3871
|
- Testing requirements specific to the story's features
|
|
3872
3872
|
- Security or performance considerations affecting the story
|
|
3873
3873
|
|
|
3874
|
-
|
|
3875
|
-
|
|
3876
|
-
[[LLM: ALWAYS cite the source document and section for each technical detail you include. This helps the dev agent verify information if needed.]]
|
|
3874
|
+
ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
3877
3875
|
|
|
3878
|
-
|
|
3876
|
+
### 4. Verify Project Structure Alignment
|
|
3879
3877
|
|
|
3880
|
-
|
|
3878
|
+
- Cross-reference story requirements with Project Structure Guide from `docs/architecture/unified-project-structure.md`
|
|
3879
|
+
- Ensure file paths, component locations, or module names align with defined structures
|
|
3880
|
+
- Document any structural conflicts in "Project Structure Notes" section within the story draft
|
|
3881
3881
|
|
|
3882
|
-
|
|
3883
|
-
- Ensure any file paths, component locations, or module names implied by the story align with defined structures.
|
|
3884
|
-
- Document any structural conflicts, necessary clarifications, or undefined components/paths in a "Project Structure Notes" section within the story draft.
|
|
3882
|
+
### 5. Populate Story Template with Full Context
|
|
3885
3883
|
|
|
3886
|
-
|
|
3887
|
-
|
|
3888
|
-
-
|
|
3889
|
-
-
|
|
3890
|
-
-
|
|
3891
|
-
|
|
3892
|
-
- `Status: Draft`
|
|
3893
|
-
- `Story` (User Story statement from Epic)
|
|
3894
|
-
- `Acceptance Criteria (ACs)` (from Epic, to be refined if needed based on context)
|
|
3895
|
-
- **`Dev Technical Guidance` section (CRITICAL):**
|
|
3896
|
-
|
|
3897
|
-
[[LLM: This section MUST contain ONLY information extracted from the architecture shards. NEVER invent or assume technical details.]]
|
|
3898
|
-
|
|
3899
|
-
- Include ALL relevant technical details gathered from Steps 3 and 4, organized by category:
|
|
3900
|
-
- **Previous Story Insights**: Key learnings or considerations from the previous story
|
|
3884
|
+
- Create new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` using Story Template
|
|
3885
|
+
- Fill in basic story information: Title, Status (Draft), Story statement, Acceptance Criteria from Epic
|
|
3886
|
+
- **`Dev Notes` section (CRITICAL):**
|
|
3887
|
+
- CRITICAL: This section MUST contain ONLY information extracted from architecture documents. NEVER invent or assume technical details.
|
|
3888
|
+
- Include ALL relevant technical details from Steps 2-3, organized by category:
|
|
3889
|
+
- **Previous Story Insights**: Key learnings from previous story
|
|
3901
3890
|
- **Data Models**: Specific schemas, validation rules, relationships [with source references]
|
|
3902
3891
|
- **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
|
|
3903
3892
|
- **Component Specifications**: UI component details, props, state management [with source references]
|
|
@@ -3906,55 +3895,28 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
3906
3895
|
- **Technical Constraints**: Version requirements, performance considerations, security rules
|
|
3907
3896
|
- Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
|
|
3908
3897
|
- If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
|
|
3909
|
-
|
|
3910
3898
|
- **`Tasks / Subtasks` section:**
|
|
3911
|
-
- Generate
|
|
3912
|
-
- Requirements from the Epic
|
|
3913
|
-
- Technical constraints from architecture shards
|
|
3914
|
-
- Project structure from unified-project-structure.md
|
|
3915
|
-
- Testing requirements from testing-strategy.md
|
|
3899
|
+
- Generate detailed, sequential list of technical tasks based ONLY on: Epic Requirements, Story AC, Reviewed Architecture Information
|
|
3916
3900
|
- Each task must reference relevant architecture documentation
|
|
3917
|
-
- Include unit testing as explicit subtasks based on
|
|
3901
|
+
- Include unit testing as explicit subtasks based on the Testing Strategy
|
|
3918
3902
|
- Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
|
|
3919
|
-
- Add notes on project structure alignment or discrepancies found in Step
|
|
3920
|
-
- Prepare content for the "Deviation Analysis" based on any conflicts between epic requirements and architecture constraints.
|
|
3921
|
-
|
|
3922
|
-
### 7. Run Story Draft Checklist
|
|
3903
|
+
- Add notes on project structure alignment or discrepancies found in Step 4
|
|
3923
3904
|
|
|
3924
|
-
|
|
3925
|
-
- Document any issues or gaps identified
|
|
3926
|
-
- Make necessary adjustments to meet quality standards
|
|
3927
|
-
- Ensure all technical guidance is properly sourced from architecture docs
|
|
3928
|
-
|
|
3929
|
-
### 8. Finalize Story File
|
|
3905
|
+
### 6. Story Draft Completion and Review
|
|
3930
3906
|
|
|
3931
3907
|
- Review all sections for completeness and accuracy
|
|
3932
3908
|
- Verify all source references are included for technical details
|
|
3933
3909
|
- Ensure tasks align with both epic requirements and architecture constraints
|
|
3934
|
-
- Update status to "Draft"
|
|
3935
|
-
-
|
|
3936
|
-
|
|
3937
|
-
|
|
3938
|
-
|
|
3939
|
-
|
|
3940
|
-
|
|
3941
|
-
-
|
|
3942
|
-
-
|
|
3943
|
-
-
|
|
3944
|
-
- Any deviations or conflicts noted between epic and architecture
|
|
3945
|
-
- Recommendations for story review before approval
|
|
3946
|
-
- Next steps: Story should be reviewed by PO for approval before dev work begins
|
|
3947
|
-
|
|
3948
|
-
### 10. Update Workflow Plan (if applicable)
|
|
3949
|
-
|
|
3950
|
-
[[LLM: After successful story creation]]
|
|
3951
|
-
|
|
3952
|
-
- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`:
|
|
3953
|
-
- Call update-workflow-plan task to mark story creation step complete
|
|
3954
|
-
- Parameters: task: create-next-story, step_id: {from plan}, status: complete
|
|
3955
|
-
- If plan shows next step, mention it in completion message
|
|
3956
|
-
|
|
3957
|
-
[[LLM: Remember - The success of this task depends on extracting real, specific technical details from the architecture shards. The dev agent should have everything they need in the story file without having to search through multiple documents.]]
|
|
3910
|
+
- Update status to "Draft" and save the story file
|
|
3911
|
+
- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`, call update-workflow-plan task to mark story creation step complete
|
|
3912
|
+
- Execute `tasks/execute-checklist` `checklists/story-draft-checklist`
|
|
3913
|
+
- Provide summary to user including:
|
|
3914
|
+
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
3915
|
+
- Status: Draft
|
|
3916
|
+
- Key technical components included from architecture docs
|
|
3917
|
+
- Any deviations or conflicts noted between epic and architecture
|
|
3918
|
+
- Checklist Results
|
|
3919
|
+
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `validate-next-story`
|
|
3958
3920
|
==================== END: tasks#create-next-story ====================
|
|
3959
3921
|
|
|
3960
3922
|
==================== START: checklists#story-draft-checklist ====================
|
|
@@ -4099,7 +4061,7 @@ Generate a concise validation report:
|
|
|
4099
4061
|
- What questions would you have?
|
|
4100
4062
|
- What might cause delays or rework?
|
|
4101
4063
|
|
|
4102
|
-
Be pragmatic - perfect documentation doesn't exist
|
|
4064
|
+
Be pragmatic - perfect documentation doesn't exist, but it must be enough to provide the extreme context a dev agent needs to get the work down and not create a mess.]]
|
|
4103
4065
|
|
|
4104
4066
|
| Category | Status | Issues |
|
|
4105
4067
|
| ------------------------------------ | ------ | ------ |
|
|
@@ -4240,11 +4202,19 @@ When a developer marks a story as "Ready for Review", perform a comprehensive se
|
|
|
4240
4202
|
- Understand the dev notes and requirements
|
|
4241
4203
|
- Note any completion notes from the developer
|
|
4242
4204
|
|
|
4243
|
-
2. **
|
|
4205
|
+
2. **Verify Implementation Against Dev Notes Guidance**
|
|
4206
|
+
- Review the "Dev Notes" section for specific technical guidance provided to the developer
|
|
4207
|
+
- Verify the developer's implementation follows the architectural patterns specified in Dev Notes
|
|
4208
|
+
- Check that file locations match the project structure guidance in Dev Notes
|
|
4209
|
+
- Confirm any specified libraries, frameworks, or technical approaches were used correctly
|
|
4210
|
+
- Validate that security considerations mentioned in Dev Notes were implemented
|
|
4211
|
+
|
|
4212
|
+
3. **Focus on the File List**
|
|
4244
4213
|
- Verify all files listed were actually created/modified
|
|
4245
4214
|
- Check for any missing files that should have been updated
|
|
4215
|
+
- Ensure file locations align with the project structure guidance from Dev Notes
|
|
4246
4216
|
|
|
4247
|
-
|
|
4217
|
+
4. **Senior Developer Code Review**
|
|
4248
4218
|
- Review code with the eye of a senior developer
|
|
4249
4219
|
- If changes form a cohesive whole, review them together
|
|
4250
4220
|
- If changes are independent, review incrementally file by file
|
|
@@ -4256,7 +4226,7 @@ When a developer marks a story as "Ready for Review", perform a comprehensive se
|
|
|
4256
4226
|
- Security concerns
|
|
4257
4227
|
- Best practices and patterns
|
|
4258
4228
|
|
|
4259
|
-
|
|
4229
|
+
5. **Active Refactoring**
|
|
4260
4230
|
- As a senior developer, you CAN and SHOULD refactor code where improvements are needed
|
|
4261
4231
|
- When refactoring:
|
|
4262
4232
|
- Make the changes directly in the files
|
|
@@ -4265,30 +4235,32 @@ When a developer marks a story as "Ready for Review", perform a comprehensive se
|
|
|
4265
4235
|
- Ensure all tests still pass after refactoring
|
|
4266
4236
|
- Update the File List if you modify additional files
|
|
4267
4237
|
|
|
4268
|
-
|
|
4238
|
+
6. **Standards Compliance Check**
|
|
4269
4239
|
- Verify adherence to `docs/coding-standards.md`
|
|
4270
4240
|
- Check compliance with `docs/unified-project-structure.md`
|
|
4271
4241
|
- Validate testing approach against `docs/testing-strategy.md`
|
|
4272
4242
|
- Ensure all guidelines mentioned in the story are followed
|
|
4273
4243
|
|
|
4274
|
-
|
|
4244
|
+
7. **Acceptance Criteria Validation**
|
|
4275
4245
|
- Verify each AC is fully implemented
|
|
4276
4246
|
- Check for any missing functionality
|
|
4277
4247
|
- Validate edge cases are handled
|
|
4278
4248
|
|
|
4279
|
-
|
|
4249
|
+
8. **Test Coverage Review**
|
|
4280
4250
|
- Ensure unit tests cover edge cases
|
|
4281
4251
|
- Add missing tests if critical coverage is lacking
|
|
4282
4252
|
- Verify integration tests (if required) are comprehensive
|
|
4283
4253
|
- Check that test assertions are meaningful
|
|
4284
4254
|
- Look for missing test scenarios
|
|
4285
4255
|
|
|
4286
|
-
|
|
4256
|
+
9. **Documentation and Comments**
|
|
4287
4257
|
- Verify code is self-documenting where possible
|
|
4288
4258
|
- Add comments for complex logic if missing
|
|
4289
4259
|
- Ensure any API changes are documented
|
|
4290
4260
|
|
|
4291
|
-
##
|
|
4261
|
+
## Update Story File - QA Results Section ONLY
|
|
4262
|
+
|
|
4263
|
+
**CRITICAL**: You are ONLY authorized to update the "QA Results" section of the story file. DO NOT modify any other sections.
|
|
4292
4264
|
|
|
4293
4265
|
After review and any refactoring, append your results to the story file in the QA Results section:
|
|
4294
4266
|
|