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
package/dist/teams/team-all.txt
CHANGED
|
@@ -233,11 +233,13 @@ startup:
|
|
|
233
233
|
- Greet the user with your name and role, and inform of the *help command.
|
|
234
234
|
commands:
|
|
235
235
|
- help: Show numbered list of the following commands to allow selection
|
|
236
|
-
-
|
|
237
|
-
-
|
|
236
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
237
|
+
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
|
238
|
+
- doc-out: Output full document to current destination file
|
|
239
|
+
- execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
|
|
240
|
+
- research {topic}: execute task create-deep-research-prompt for architectural decisions
|
|
238
241
|
- brainstorm {topic}: Facilitate structured brainstorming session
|
|
239
|
-
-
|
|
240
|
-
- elicit: Run advanced elicitation to clarify requirements
|
|
242
|
+
- elicit: list the options under output set of information
|
|
241
243
|
- document-project: Analyze and document existing project structure comprehensively
|
|
242
244
|
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
|
243
245
|
dependencies:
|
|
@@ -297,10 +299,11 @@ startup:
|
|
|
297
299
|
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
|
298
300
|
commands:
|
|
299
301
|
- help: Show numbered list of the following commands to allow selection
|
|
300
|
-
-
|
|
301
|
-
-
|
|
302
|
-
-
|
|
303
|
-
-
|
|
302
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
303
|
+
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
|
304
|
+
- doc-out: Output full document to current destination file
|
|
305
|
+
- execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
|
|
306
|
+
- research {topic}: execute task create-deep-research-prompt for architectural decisions
|
|
304
307
|
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
|
|
305
308
|
dependencies:
|
|
306
309
|
tasks:
|
|
@@ -337,45 +340,37 @@ agent:
|
|
|
337
340
|
customization: null
|
|
338
341
|
startup:
|
|
339
342
|
- Announce: Greet the user with your name and role, and inform of the *help command.
|
|
340
|
-
- CRITICAL:
|
|
341
|
-
- CRITICAL:
|
|
342
|
-
- CRITICAL: Do NOT
|
|
343
|
-
- CRITICAL: Do NOT begin development until told to proceed
|
|
343
|
+
- CRITICAL: Read the following full files as these are your explicit rules for development standards for this project - {root}/core-config.yaml devLoadAlwaysFiles list
|
|
344
|
+
- 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
|
|
345
|
+
- CRITICAL: Do NOT begin development until a story is not in draft mode and you are told to proceed
|
|
344
346
|
persona:
|
|
345
347
|
role: Expert Senior Software Engineer & Implementation Specialist
|
|
346
348
|
style: Extremely concise, pragmatic, detail-oriented, solution-focused
|
|
347
349
|
identity: Expert who implements stories by reading requirements and executing tasks sequentially with comprehensive testing
|
|
348
350
|
focus: Executing story tasks with precision, updating Dev Agent Record sections only, maintaining minimal context overhead
|
|
349
351
|
core_principles:
|
|
350
|
-
- CRITICAL: Story
|
|
351
|
-
- CRITICAL:
|
|
352
|
-
-
|
|
353
|
-
-
|
|
354
|
-
- Quality Gate Discipline - NEVER complete tasks with failing automated validations
|
|
355
|
-
- Debug Log Discipline - Log temp changes to md table in devDebugLog. Revert after fix.
|
|
356
|
-
- Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
|
|
357
|
-
- Code Excellence - Clean, secure, maintainable code per loaded standards
|
|
358
|
-
- Numbered Options - Always use numbered lists when presenting choices
|
|
352
|
+
- 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.
|
|
353
|
+
- CRITICAL: ONLY update story file Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
|
|
354
|
+
- CRITICAL: FOLLOW THE develop-story command when the user tells you to implement the story
|
|
355
|
+
- Numbered Options - Always use numbered lists when presenting choices to the user
|
|
359
356
|
commands:
|
|
360
357
|
- help: Show numbered list of the following commands to allow selection
|
|
361
358
|
- run-tests: Execute linting and tests
|
|
362
|
-
-
|
|
363
|
-
- complete-story: Finalize to "Review"
|
|
359
|
+
- 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.
|
|
364
360
|
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
updates-ONLY:
|
|
368
|
-
-
|
|
369
|
-
-
|
|
370
|
-
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
done: Code matches reqs + All validations pass + Follows standards + File List complete
|
|
375
|
-
completion: All [x]→Validations pass→Integration(if noted)→E2E(if noted)→DoD→Update File List→Mark Ready for Review→HALT
|
|
361
|
+
develop-story:
|
|
362
|
+
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
|
|
363
|
+
story-file-updates-ONLY:
|
|
364
|
+
- CRITICAL: ONLY UPDATE THE STORY FILE WITH UPDATES TO SECTIONS INDICATED BELOW. DO NOT MODIFY ANY OTHER SECTIONS.
|
|
365
|
+
- 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
|
|
366
|
+
- CRITICAL: DO NOT modify Status, Story, Acceptance Criteria, Dev Notes, Testing sections, or any other sections not listed above
|
|
367
|
+
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'
|
|
368
|
+
ready-for-review: Code matches requirements + All validations pass + Follows standards + File List complete
|
|
369
|
+
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'
|
|
376
370
|
dependencies:
|
|
377
371
|
tasks:
|
|
378
372
|
- execute-checklist
|
|
373
|
+
- validate-next-story
|
|
379
374
|
checklists:
|
|
380
375
|
- story-dod-checklist
|
|
381
376
|
```
|
|
@@ -417,9 +412,10 @@ startup:
|
|
|
417
412
|
- Greet the user with your name and role, and inform of the *help command.
|
|
418
413
|
commands:
|
|
419
414
|
- help: Show numbered list of the following commands to allow selection
|
|
420
|
-
-
|
|
421
|
-
-
|
|
422
|
-
-
|
|
415
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
416
|
+
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
|
417
|
+
- doc-out: Output full document to current destination file
|
|
418
|
+
- exit: Exit (confirm)
|
|
423
419
|
dependencies:
|
|
424
420
|
tasks:
|
|
425
421
|
- create-doc
|
|
@@ -480,14 +476,16 @@ startup:
|
|
|
480
476
|
- Greet the user with your name and role, and inform of the *help command.
|
|
481
477
|
commands:
|
|
482
478
|
- help: Show numbered list of the following commands to allow selection
|
|
483
|
-
-
|
|
484
|
-
-
|
|
485
|
-
-
|
|
486
|
-
-
|
|
487
|
-
- correct-course: Analyze and suggest project course corrections
|
|
479
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
480
|
+
- execute-checklist {checklist}: Run task execute-checklist (default->po-master-checklist)
|
|
481
|
+
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
|
482
|
+
- correct-course: execute the correct-course task
|
|
488
483
|
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
|
|
489
484
|
- create-story: Create user story from requirements (task brownfield-create-story)
|
|
490
|
-
-
|
|
485
|
+
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
|
486
|
+
- doc-out: Output full document to current destination file
|
|
487
|
+
- validate-story-draft {story}: run the task validate-next-story against the provided story file
|
|
488
|
+
- exit: Exit (confirm)
|
|
491
489
|
dependencies:
|
|
492
490
|
tasks:
|
|
493
491
|
- execute-checklist
|
|
@@ -495,6 +493,7 @@ dependencies:
|
|
|
495
493
|
- correct-course
|
|
496
494
|
- brownfield-create-epic
|
|
497
495
|
- brownfield-create-story
|
|
496
|
+
- validate-next-story
|
|
498
497
|
templates:
|
|
499
498
|
- story-tmpl
|
|
500
499
|
checklists:
|
|
@@ -541,10 +540,15 @@ persona:
|
|
|
541
540
|
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
|
542
541
|
startup:
|
|
543
542
|
- Greet the user with your name and role, and inform of the *help command.
|
|
543
|
+
story-file-permissions:
|
|
544
|
+
- CRITICAL: When reviewing stories, you are ONLY authorized to update the "QA Results" section of story files
|
|
545
|
+
- 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
|
|
546
|
+
- CRITICAL: Your updates must be limited to appending your review results in the QA Results section only
|
|
544
547
|
commands:
|
|
545
548
|
- help: Show numbered list of the following commands to allow selection
|
|
546
|
-
-
|
|
547
|
-
-
|
|
549
|
+
- 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
|
|
550
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
551
|
+
- exit: Say goodbye as the QA Engineer, and then abandon inhabiting this persona
|
|
548
552
|
dependencies:
|
|
549
553
|
tasks:
|
|
550
554
|
- review-story
|
|
@@ -587,10 +591,9 @@ startup:
|
|
|
587
591
|
- Only execute tasks when user explicitly requests them
|
|
588
592
|
commands:
|
|
589
593
|
- help: Show numbered list of the following commands to allow selection
|
|
590
|
-
-
|
|
591
|
-
-
|
|
592
|
-
-
|
|
593
|
-
- checklist {checklist}: Show numbered list of checklists, execute selection
|
|
594
|
+
- draft: Execute task create-next-story
|
|
595
|
+
- correct-course: Execute task correct-course
|
|
596
|
+
- checklist {checklist}: Show numbered list of checklists if not provided, execute task execute-checklist
|
|
594
597
|
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
|
|
595
598
|
dependencies:
|
|
596
599
|
tasks:
|
|
@@ -630,16 +633,11 @@ persona:
|
|
|
630
633
|
identity: UX Expert specializing in user experience design and creating intuitive interfaces
|
|
631
634
|
focus: User research, interaction design, visual design, accessibility, AI-powered UI generation
|
|
632
635
|
core_principles:
|
|
633
|
-
- User-
|
|
634
|
-
- Evidence-Based Design - Base decisions on research and testing, not assumptions
|
|
635
|
-
- Accessibility is Non-Negotiable - Design for the full spectrum of human diversity
|
|
636
|
+
- User-Centric above all - Every design decision must serve user needs
|
|
636
637
|
- Simplicity Through Iteration - Start simple, refine based on feedback
|
|
637
|
-
- Consistency Builds Trust - Maintain consistent patterns and behaviors
|
|
638
638
|
- Delight in the Details - Thoughtful micro-interactions create memorable experiences
|
|
639
639
|
- Design for Real Scenarios - Consider edge cases, errors, and loading states
|
|
640
640
|
- Collaborate, Don't Dictate - Best solutions emerge from cross-functional work
|
|
641
|
-
- Measure and Learn - Continuously gather feedback and iterate
|
|
642
|
-
- Ethical Responsibility - Consider broader impact on user well-being and society
|
|
643
641
|
- You have a keen eye for detail and a deep empathy for users.
|
|
644
642
|
- You're particularly skilled at translating user needs into beautiful, functional designs.
|
|
645
643
|
- You can craft effective prompts for AI UI generation tools like v0, or Lovable.
|
|
@@ -648,11 +646,10 @@ startup:
|
|
|
648
646
|
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
|
|
649
647
|
commands:
|
|
650
648
|
- help: Show numbered list of the following commands to allow selection
|
|
651
|
-
-
|
|
652
|
-
- create-doc {template}: Create doc (no template = show available templates)
|
|
649
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
653
650
|
- generate-ui-prompt: Create AI frontend generation prompt
|
|
654
|
-
- research {topic}:
|
|
655
|
-
- execute-checklist {checklist}: Run
|
|
651
|
+
- research {topic}: Execute create-deep-research-prompt task to generate a prompt to init UX deep research
|
|
652
|
+
- execute-checklist {checklist}: Run task execute-checklist (default->po-master-checklist)
|
|
656
653
|
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
|
657
654
|
dependencies:
|
|
658
655
|
tasks:
|
|
@@ -3419,9 +3416,11 @@ Apply the advanced elicitation task after major sections to refine based on user
|
|
|
3419
3416
|
==================== END: tasks#document-project ====================
|
|
3420
3417
|
|
|
3421
3418
|
==================== START: templates#project-brief-tmpl ====================
|
|
3422
|
-
|
|
3419
|
+
---
|
|
3420
|
+
defaultOutput: docs/brief.md
|
|
3421
|
+
---
|
|
3423
3422
|
|
|
3424
|
-
|
|
3423
|
+
# Project Brief: {{Project Name}}
|
|
3425
3424
|
|
|
3426
3425
|
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
|
3427
3426
|
|
|
@@ -7284,6 +7283,143 @@ After presenting the report, ask the user if they would like detailed analysis o
|
|
|
7284
7283
|
None Listed
|
|
7285
7284
|
==================== END: data#technical-preferences ====================
|
|
7286
7285
|
|
|
7286
|
+
==================== START: tasks#validate-next-story ====================
|
|
7287
|
+
# Validate Next Story Task
|
|
7288
|
+
|
|
7289
|
+
## Purpose
|
|
7290
|
+
|
|
7291
|
+
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.
|
|
7292
|
+
|
|
7293
|
+
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
7294
|
+
|
|
7295
|
+
### 0. Load Core Configuration and Inputs
|
|
7296
|
+
|
|
7297
|
+
- Load `.bmad-core/core-config.yaml` from the project root
|
|
7298
|
+
- If the file does not exist, HALT and inform the user: "core-config.yaml not found. This file is required for story validation."
|
|
7299
|
+
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`
|
|
7300
|
+
- Identify and load the following inputs:
|
|
7301
|
+
- **Story file**: The drafted story to validate (provided by user or discovered in `devStoryLocation`)
|
|
7302
|
+
- **Parent epic**: The epic containing this story's requirements
|
|
7303
|
+
- **Architecture documents**: Based on configuration (sharded or monolithic)
|
|
7304
|
+
- **Story template**: `bmad-core/templates/story-tmpl.md` for completeness validation
|
|
7305
|
+
|
|
7306
|
+
### 1. Template Completeness Validation
|
|
7307
|
+
|
|
7308
|
+
- Load `bmad-core/templates/story-tmpl.md` and extract all section headings from the template
|
|
7309
|
+
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
|
|
7310
|
+
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
|
|
7311
|
+
- **Agent section verification**: Confirm all sections from template exist for future agent use
|
|
7312
|
+
- **Structure compliance**: Verify story follows template structure and formatting
|
|
7313
|
+
|
|
7314
|
+
### 2. File Structure and Source Tree Validation
|
|
7315
|
+
|
|
7316
|
+
- **File paths clarity**: Are new/existing files to be created/modified clearly specified?
|
|
7317
|
+
- **Source tree relevance**: Is relevant project structure included in Dev Notes?
|
|
7318
|
+
- **Directory structure**: Are new directories/components properly located according to project structure?
|
|
7319
|
+
- **File creation sequence**: Do tasks specify where files should be created in logical order?
|
|
7320
|
+
- **Path accuracy**: Are file paths consistent with project structure from architecture docs?
|
|
7321
|
+
|
|
7322
|
+
### 3. UI/Frontend Completeness Validation (if applicable)
|
|
7323
|
+
|
|
7324
|
+
- **Component specifications**: Are UI components sufficiently detailed for implementation?
|
|
7325
|
+
- **Styling/design guidance**: Is visual implementation guidance clear?
|
|
7326
|
+
- **User interaction flows**: Are UX patterns and behaviors specified?
|
|
7327
|
+
- **Responsive/accessibility**: Are these considerations addressed if required?
|
|
7328
|
+
- **Integration points**: Are frontend-backend integration points clear?
|
|
7329
|
+
|
|
7330
|
+
### 4. Acceptance Criteria Satisfaction Assessment
|
|
7331
|
+
|
|
7332
|
+
- **AC coverage**: Will all acceptance criteria be satisfied by the listed tasks?
|
|
7333
|
+
- **AC testability**: Are acceptance criteria measurable and verifiable?
|
|
7334
|
+
- **Missing scenarios**: Are edge cases or error conditions covered?
|
|
7335
|
+
- **Success definition**: Is "done" clearly defined for each AC?
|
|
7336
|
+
- **Task-AC mapping**: Are tasks properly linked to specific acceptance criteria?
|
|
7337
|
+
|
|
7338
|
+
### 5. Validation and Testing Instructions Review
|
|
7339
|
+
|
|
7340
|
+
- **Test approach clarity**: Are testing methods clearly specified?
|
|
7341
|
+
- **Test scenarios**: Are key test cases identified?
|
|
7342
|
+
- **Validation steps**: Are acceptance criteria validation steps clear?
|
|
7343
|
+
- **Testing tools/frameworks**: Are required testing tools specified?
|
|
7344
|
+
- **Test data requirements**: Are test data needs identified?
|
|
7345
|
+
|
|
7346
|
+
### 6. Security Considerations Assessment (if applicable)
|
|
7347
|
+
|
|
7348
|
+
- **Security requirements**: Are security needs identified and addressed?
|
|
7349
|
+
- **Authentication/authorization**: Are access controls specified?
|
|
7350
|
+
- **Data protection**: Are sensitive data handling requirements clear?
|
|
7351
|
+
- **Vulnerability prevention**: Are common security issues addressed?
|
|
7352
|
+
- **Compliance requirements**: Are regulatory/compliance needs addressed?
|
|
7353
|
+
|
|
7354
|
+
### 7. Tasks/Subtasks Sequence Validation
|
|
7355
|
+
|
|
7356
|
+
- **Logical order**: Do tasks follow proper implementation sequence?
|
|
7357
|
+
- **Dependencies**: Are task dependencies clear and correct?
|
|
7358
|
+
- **Granularity**: Are tasks appropriately sized and actionable?
|
|
7359
|
+
- **Completeness**: Do tasks cover all requirements and acceptance criteria?
|
|
7360
|
+
- **Blocking issues**: Are there any tasks that would block others?
|
|
7361
|
+
|
|
7362
|
+
### 8. Anti-Hallucination Verification
|
|
7363
|
+
|
|
7364
|
+
- **Source verification**: Every technical claim must be traceable to source documents
|
|
7365
|
+
- **Architecture alignment**: Dev Notes content matches architecture specifications
|
|
7366
|
+
- **No invented details**: Flag any technical decisions not supported by source documents
|
|
7367
|
+
- **Reference accuracy**: Verify all source references are correct and accessible
|
|
7368
|
+
- **Fact checking**: Cross-reference claims against epic and architecture documents
|
|
7369
|
+
|
|
7370
|
+
### 9. Dev Agent Implementation Readiness
|
|
7371
|
+
|
|
7372
|
+
- **Self-contained context**: Can the story be implemented without reading external docs?
|
|
7373
|
+
- **Clear instructions**: Are implementation steps unambiguous?
|
|
7374
|
+
- **Complete technical context**: Are all required technical details present in Dev Notes?
|
|
7375
|
+
- **Missing information**: Identify any critical information gaps
|
|
7376
|
+
- **Actionability**: Are all tasks actionable by a development agent?
|
|
7377
|
+
|
|
7378
|
+
### 10. Generate Validation Report
|
|
7379
|
+
|
|
7380
|
+
Provide a structured validation report including:
|
|
7381
|
+
|
|
7382
|
+
#### Template Compliance Issues
|
|
7383
|
+
|
|
7384
|
+
- Missing sections from story template
|
|
7385
|
+
- Unfilled placeholders or template variables
|
|
7386
|
+
- Structural formatting issues
|
|
7387
|
+
|
|
7388
|
+
#### Critical Issues (Must Fix - Story Blocked)
|
|
7389
|
+
|
|
7390
|
+
- Missing essential information for implementation
|
|
7391
|
+
- Inaccurate or unverifiable technical claims
|
|
7392
|
+
- Incomplete acceptance criteria coverage
|
|
7393
|
+
- Missing required sections
|
|
7394
|
+
|
|
7395
|
+
#### Should-Fix Issues (Important Quality Improvements)
|
|
7396
|
+
|
|
7397
|
+
- Unclear implementation guidance
|
|
7398
|
+
- Missing security considerations
|
|
7399
|
+
- Task sequencing problems
|
|
7400
|
+
- Incomplete testing instructions
|
|
7401
|
+
|
|
7402
|
+
#### Nice-to-Have Improvements (Optional Enhancements)
|
|
7403
|
+
|
|
7404
|
+
- Additional context that would help implementation
|
|
7405
|
+
- Clarifications that would improve efficiency
|
|
7406
|
+
- Documentation improvements
|
|
7407
|
+
|
|
7408
|
+
#### Anti-Hallucination Findings
|
|
7409
|
+
|
|
7410
|
+
- Unverifiable technical claims
|
|
7411
|
+
- Missing source references
|
|
7412
|
+
- Inconsistencies with architecture documents
|
|
7413
|
+
- Invented libraries, patterns, or standards
|
|
7414
|
+
|
|
7415
|
+
#### Final Assessment
|
|
7416
|
+
|
|
7417
|
+
- **GO**: Story is ready for implementation
|
|
7418
|
+
- **NO-GO**: Story requires fixes before implementation
|
|
7419
|
+
- **Implementation Readiness Score**: 1-10 scale
|
|
7420
|
+
- **Confidence Level**: High/Medium/Low for successful implementation
|
|
7421
|
+
==================== END: tasks#validate-next-story ====================
|
|
7422
|
+
|
|
7287
7423
|
==================== START: checklists#story-dod-checklist ====================
|
|
7288
7424
|
# Story Definition of Done (DoD) Checklist
|
|
7289
7425
|
|
|
@@ -9009,17 +9145,32 @@ Keep it action-oriented and forward-looking.]]
|
|
|
9009
9145
|
==================== END: checklists#change-checklist ====================
|
|
9010
9146
|
|
|
9011
9147
|
==================== START: templates#story-tmpl ====================
|
|
9148
|
+
---
|
|
9149
|
+
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
|
9150
|
+
smAgent:
|
|
9151
|
+
editableSections: Status, Story, Acceptance Criteria, Tasks / Subtasks, Dev Notes, Testing, Change Log
|
|
9152
|
+
sectionSpecificInstructions:
|
|
9153
|
+
"Dev Notes":
|
|
9154
|
+
- Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story
|
|
9155
|
+
- Do not invent information.
|
|
9156
|
+
- If known add Relevant Source Tree info that relates to this story.
|
|
9157
|
+
- If there were important notes from previous story that are relevant to this one, include them here.
|
|
9158
|
+
- 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.
|
|
9159
|
+
Testing:
|
|
9160
|
+
- List Relevant Testing Standards from Architecture the Developer needs to conform to (test file location, test standards, etc)
|
|
9161
|
+
---
|
|
9162
|
+
|
|
9012
9163
|
# Story {{EpicNum}}.{{StoryNum}}: {{Short Title Copied from Epic File specific story}}
|
|
9013
9164
|
|
|
9014
9165
|
## Status: {{ Draft | Approved | InProgress | Review | Done }}
|
|
9015
9166
|
|
|
9016
9167
|
## Story
|
|
9017
9168
|
|
|
9018
|
-
|
|
9019
|
-
|
|
9020
|
-
|
|
9169
|
+
**As a** {{role}},\
|
|
9170
|
+
**I want** {{action}},\
|
|
9171
|
+
**so that** {{benefit}}
|
|
9021
9172
|
|
|
9022
|
-
## Acceptance Criteria
|
|
9173
|
+
## Acceptance Criteria
|
|
9023
9174
|
|
|
9024
9175
|
{{ Copy of Acceptance Criteria numbered list }}
|
|
9025
9176
|
|
|
@@ -9034,20 +9185,12 @@ Keep it action-oriented and forward-looking.]]
|
|
|
9034
9185
|
|
|
9035
9186
|
## Dev Notes
|
|
9036
9187
|
|
|
9037
|
-
[[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.]]
|
|
9038
|
-
|
|
9039
9188
|
### Testing
|
|
9040
9189
|
|
|
9041
|
-
|
|
9042
|
-
Dev Note: Story Requires the following tests:
|
|
9043
|
-
|
|
9044
|
-
- [ ] {{type f.e. Jest}} Unit Tests: (nextToFile: {{true|false}}), coverage requirement: {{from strategy or default 80%}}
|
|
9045
|
-
- [ ] {{type f.e. Jest with in memory db}} Integration Test (Test Location): location: {{Integration test location f.e. `/tests/story-name/foo.spec.cs` or `next to handler`}}
|
|
9046
|
-
- [ ] {{type f.e. Cypress}} E2E: location: {{f.e. `/e2e/{epic-name/bar.test.ts`}}
|
|
9047
|
-
|
|
9048
|
-
Manual Test Steps: [[LLM: Include how if possible the user can manually test the functionality when story is Ready for Review, if any]]
|
|
9190
|
+
## Change Log
|
|
9049
9191
|
|
|
9050
|
-
|
|
9192
|
+
| Date | Version | Description | Author |
|
|
9193
|
+
| :--- | :------ | :---------- | :----- |
|
|
9051
9194
|
|
|
9052
9195
|
## Dev Agent Record
|
|
9053
9196
|
|
|
@@ -9055,29 +9198,11 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
|
|
9055
9198
|
|
|
9056
9199
|
### Debug Log References
|
|
9057
9200
|
|
|
9058
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update]]
|
|
9059
|
-
[[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]]
|
|
9060
|
-
|
|
9061
9201
|
### Completion Notes List
|
|
9062
9202
|
|
|
9063
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
|
9064
|
-
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
|
9065
|
-
|
|
9066
9203
|
### File List
|
|
9067
9204
|
|
|
9068
|
-
[[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
|
|
9069
|
-
|
|
9070
|
-
### Change Log
|
|
9071
|
-
|
|
9072
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
|
9073
|
-
[[LLM: (Dev Agent) Track document versions and changes during development that deviate from story dev start]]
|
|
9074
|
-
|
|
9075
|
-
| Date | Version | Description | Author |
|
|
9076
|
-
| :--- | :------ | :---------- | :----- |
|
|
9077
|
-
|
|
9078
9205
|
## QA Results
|
|
9079
|
-
|
|
9080
|
-
[[LLM: QA Agent Results]]
|
|
9081
9206
|
==================== END: templates#story-tmpl ====================
|
|
9082
9207
|
|
|
9083
9208
|
==================== START: checklists#po-master-checklist ====================
|
|
@@ -9544,11 +9669,19 @@ When a developer marks a story as "Ready for Review", perform a comprehensive se
|
|
|
9544
9669
|
- Understand the dev notes and requirements
|
|
9545
9670
|
- Note any completion notes from the developer
|
|
9546
9671
|
|
|
9547
|
-
2. **
|
|
9672
|
+
2. **Verify Implementation Against Dev Notes Guidance**
|
|
9673
|
+
- Review the "Dev Notes" section for specific technical guidance provided to the developer
|
|
9674
|
+
- Verify the developer's implementation follows the architectural patterns specified in Dev Notes
|
|
9675
|
+
- Check that file locations match the project structure guidance in Dev Notes
|
|
9676
|
+
- Confirm any specified libraries, frameworks, or technical approaches were used correctly
|
|
9677
|
+
- Validate that security considerations mentioned in Dev Notes were implemented
|
|
9678
|
+
|
|
9679
|
+
3. **Focus on the File List**
|
|
9548
9680
|
- Verify all files listed were actually created/modified
|
|
9549
9681
|
- Check for any missing files that should have been updated
|
|
9682
|
+
- Ensure file locations align with the project structure guidance from Dev Notes
|
|
9550
9683
|
|
|
9551
|
-
|
|
9684
|
+
4. **Senior Developer Code Review**
|
|
9552
9685
|
- Review code with the eye of a senior developer
|
|
9553
9686
|
- If changes form a cohesive whole, review them together
|
|
9554
9687
|
- If changes are independent, review incrementally file by file
|
|
@@ -9560,7 +9693,7 @@ When a developer marks a story as "Ready for Review", perform a comprehensive se
|
|
|
9560
9693
|
- Security concerns
|
|
9561
9694
|
- Best practices and patterns
|
|
9562
9695
|
|
|
9563
|
-
|
|
9696
|
+
5. **Active Refactoring**
|
|
9564
9697
|
- As a senior developer, you CAN and SHOULD refactor code where improvements are needed
|
|
9565
9698
|
- When refactoring:
|
|
9566
9699
|
- Make the changes directly in the files
|
|
@@ -9569,30 +9702,32 @@ When a developer marks a story as "Ready for Review", perform a comprehensive se
|
|
|
9569
9702
|
- Ensure all tests still pass after refactoring
|
|
9570
9703
|
- Update the File List if you modify additional files
|
|
9571
9704
|
|
|
9572
|
-
|
|
9705
|
+
6. **Standards Compliance Check**
|
|
9573
9706
|
- Verify adherence to `docs/coding-standards.md`
|
|
9574
9707
|
- Check compliance with `docs/unified-project-structure.md`
|
|
9575
9708
|
- Validate testing approach against `docs/testing-strategy.md`
|
|
9576
9709
|
- Ensure all guidelines mentioned in the story are followed
|
|
9577
9710
|
|
|
9578
|
-
|
|
9711
|
+
7. **Acceptance Criteria Validation**
|
|
9579
9712
|
- Verify each AC is fully implemented
|
|
9580
9713
|
- Check for any missing functionality
|
|
9581
9714
|
- Validate edge cases are handled
|
|
9582
9715
|
|
|
9583
|
-
|
|
9716
|
+
8. **Test Coverage Review**
|
|
9584
9717
|
- Ensure unit tests cover edge cases
|
|
9585
9718
|
- Add missing tests if critical coverage is lacking
|
|
9586
9719
|
- Verify integration tests (if required) are comprehensive
|
|
9587
9720
|
- Check that test assertions are meaningful
|
|
9588
9721
|
- Look for missing test scenarios
|
|
9589
9722
|
|
|
9590
|
-
|
|
9723
|
+
9. **Documentation and Comments**
|
|
9591
9724
|
- Verify code is self-documenting where possible
|
|
9592
9725
|
- Add comments for complex logic if missing
|
|
9593
9726
|
- Ensure any API changes are documented
|
|
9594
9727
|
|
|
9595
|
-
##
|
|
9728
|
+
## Update Story File - QA Results Section ONLY
|
|
9729
|
+
|
|
9730
|
+
**CRITICAL**: You are ONLY authorized to update the "QA Results" section of the story file. DO NOT modify any other sections.
|
|
9596
9731
|
|
|
9597
9732
|
After review and any refactoring, append your results to the story file in the QA Results section:
|
|
9598
9733
|
|
|
@@ -9667,187 +9802,62 @@ After review:
|
|
|
9667
9802
|
|
|
9668
9803
|
## Purpose
|
|
9669
9804
|
|
|
9670
|
-
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.
|
|
9805
|
+
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.
|
|
9671
9806
|
|
|
9672
|
-
## Task Execution
|
|
9807
|
+
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
9673
9808
|
|
|
9674
|
-
### 0. Load Core Configuration
|
|
9675
|
-
|
|
9676
|
-
[[LLM: CRITICAL - This MUST be your first step]]
|
|
9809
|
+
### 0. Load Core Configuration and Check Workflow
|
|
9677
9810
|
|
|
9678
9811
|
- Load `.bmad-core/core-config.yaml` from the project root
|
|
9679
|
-
- If the file does not exist:
|
|
9680
|
-
|
|
9681
|
-
|
|
9682
|
-
2. Run the BMad installer against your project to upgrade and add the file automatically
|
|
9683
|
-
Please add and configure core-config.yaml before proceeding."
|
|
9684
|
-
- Extract the following key configurations:
|
|
9685
|
-
- `devStoryLocation`: Where to save story files
|
|
9686
|
-
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
|
9687
|
-
- `prd.prdFile`: Location of monolithic PRD (if not sharded)
|
|
9688
|
-
- `prd.prdShardedLocation`: Location of sharded epic files
|
|
9689
|
-
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
|
9690
|
-
- `architecture.architectureVersion`: Architecture document version
|
|
9691
|
-
- `architecture.architectureSharded`: Whether architecture is sharded
|
|
9692
|
-
- `architecture.architectureFile`: Location of monolithic architecture
|
|
9693
|
-
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
|
9694
|
-
- `workflow.trackProgress`: Whether workflow plan tracking is enabled
|
|
9695
|
-
- `workflow.planFile`: Location of workflow plan (if tracking enabled)
|
|
9696
|
-
|
|
9697
|
-
### 0.5 Check Workflow Plan (if configured)
|
|
9698
|
-
|
|
9699
|
-
[[LLM: Check if workflow plan tracking is enabled]]
|
|
9700
|
-
|
|
9701
|
-
- If `workflow.trackProgress: true`, check for active plan at `workflow.planFile`
|
|
9702
|
-
- If plan exists:
|
|
9703
|
-
- Parse plan to check if story creation is the expected next step
|
|
9704
|
-
- If out of sequence and `workflow.enforceSequence: true`:
|
|
9705
|
-
- Show warning: "The workflow plan indicates you should complete {expected_step} before creating stories."
|
|
9706
|
-
- Block execution unless user explicitly overrides
|
|
9707
|
-
- If out of sequence and `workflow.enforceSequence: false`:
|
|
9708
|
-
- Show warning but allow continuation with confirmation
|
|
9709
|
-
- Continue with story identification after plan check
|
|
9812
|
+
- 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."
|
|
9813
|
+
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`, `workflow.*`
|
|
9814
|
+
- If `workflow.trackProgress: true`, use `utils/plan-management.md` to check plan sequence and warn if out of order
|
|
9710
9815
|
|
|
9711
9816
|
### 1. Identify Next Story for Preparation
|
|
9712
9817
|
|
|
9713
|
-
#### 1.1 Locate Epic Files
|
|
9714
|
-
|
|
9715
|
-
- Based on `prdSharded` from config:
|
|
9716
|
-
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
|
9717
|
-
- **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
|
|
9718
|
-
|
|
9719
|
-
#### 1.2 Review Existing Stories
|
|
9818
|
+
#### 1.1 Locate Epic Files and Review Existing Stories
|
|
9720
9819
|
|
|
9721
|
-
-
|
|
9722
|
-
- If
|
|
9723
|
-
- **If
|
|
9724
|
-
- Verify
|
|
9725
|
-
- If
|
|
9820
|
+
- Based on `prdSharded` from config, locate epic files (sharded location/pattern or monolithic PRD sections)
|
|
9821
|
+
- If `devStoryLocation` has story files, load the highest `{epicNum}.{storyNum}.story.md` file
|
|
9822
|
+
- **If highest story exists:**
|
|
9823
|
+
- 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?"
|
|
9824
|
+
- If proceeding, select next sequential story in the current epic
|
|
9825
|
+
- 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"
|
|
9826
|
+
- **CRITICAL**: NEVER automatically skip to another epic. User MUST explicitly instruct which story to create.
|
|
9827
|
+
- **If no story files exist:** The next story is ALWAYS 1.1 (first story of first epic)
|
|
9828
|
+
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}"
|
|
9726
9829
|
|
|
9727
|
-
|
|
9728
|
-
ALERT: Found incomplete story:
|
|
9729
|
-
File: {lastEpicNum}.{lastStoryNum}.story.md
|
|
9730
|
-
Status: [current status]
|
|
9731
|
-
|
|
9732
|
-
Would you like to:
|
|
9733
|
-
1. View the incomplete story details (instructs user to do so, agent does not display)
|
|
9734
|
-
2. Cancel new story creation at this time
|
|
9735
|
-
3. Accept risk & Override to create the next story in draft
|
|
9736
|
-
|
|
9737
|
-
Please choose an option (1/2/3):
|
|
9738
|
-
```
|
|
9739
|
-
|
|
9740
|
-
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
|
|
9741
|
-
- 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).
|
|
9742
|
-
- If the next sequential story has unmet prerequisites, present this to the user:
|
|
9743
|
-
|
|
9744
|
-
```plaintext
|
|
9745
|
-
ALERT: Next story has unmet prerequisites:
|
|
9746
|
-
Story: {epicNum}.{storyNum} - {Story Title}
|
|
9747
|
-
Prerequisites not met: [list specific prerequisites]
|
|
9748
|
-
|
|
9749
|
-
Would you like to:
|
|
9750
|
-
1. Create the story anyway (mark prerequisites as pending)
|
|
9751
|
-
2. Skip to a different story (requires your specific instruction)
|
|
9752
|
-
3. Cancel story creation
|
|
9753
|
-
|
|
9754
|
-
Please choose an option (1/2/3):
|
|
9755
|
-
```
|
|
9756
|
-
|
|
9757
|
-
- If there are no more stories in the current epic (e.g., 2.9 was done and there is no 2.10):
|
|
9758
|
-
|
|
9759
|
-
```plaintext
|
|
9760
|
-
Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed.
|
|
9761
|
-
|
|
9762
|
-
Would you like to:
|
|
9763
|
-
1. Begin Epic {epicNum + 1} with story {epicNum + 1}.1
|
|
9764
|
-
2. Select a specific story to work on
|
|
9765
|
-
3. Cancel story creation
|
|
9766
|
-
|
|
9767
|
-
Please choose an option (1/2/3):
|
|
9768
|
-
```
|
|
9830
|
+
### 2. Gather Story Requirements and Previous Story Context
|
|
9769
9831
|
|
|
9770
|
-
|
|
9832
|
+
- Extract story requirements from the identified epic file
|
|
9833
|
+
- If previous story exists, review Dev Agent Record sections for:
|
|
9834
|
+
- Completion Notes and Debug Log References
|
|
9835
|
+
- Implementation deviations and technical decisions
|
|
9836
|
+
- Challenges encountered and lessons learned
|
|
9837
|
+
- Extract relevant insights that inform the current story's preparation
|
|
9771
9838
|
|
|
9772
|
-
|
|
9773
|
-
- The next story is ALWAYS 1.1 (the first story of the first epic).
|
|
9774
|
-
- If story 1.1 has unmet prerequisites, follow the same alert process as above.
|
|
9775
|
-
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
|
|
9839
|
+
### 3. Gather Architecture Context
|
|
9776
9840
|
|
|
9777
|
-
|
|
9841
|
+
#### 3.1 Determine Architecture Reading Strategy
|
|
9778
9842
|
|
|
9779
|
-
-
|
|
9780
|
-
-
|
|
9781
|
-
- Keep a record of this original epic-defined scope for later deviation analysis.
|
|
9843
|
+
- **If `architectureVersion: >= v4` and `architectureSharded: true`**: Read `{architectureShardedLocation}/index.md` then follow structured reading order below
|
|
9844
|
+
- **Else**: Use monolithic `architectureFile` for similar sections
|
|
9782
9845
|
|
|
9783
|
-
|
|
9846
|
+
#### 3.2 Read Architecture Documents Based on Story Type
|
|
9784
9847
|
|
|
9785
|
-
|
|
9848
|
+
**For ALL Stories:** tech-stack.md, unified-project-structure.md, coding-standards.md, testing-strategy.md
|
|
9786
9849
|
|
|
9787
|
-
|
|
9788
|
-
- Read the previous sequential story from `docs/stories`
|
|
9789
|
-
- Pay special attention to:
|
|
9790
|
-
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
|
|
9791
|
-
- Any deviations from planned implementation
|
|
9792
|
-
- Technical decisions made during implementation
|
|
9793
|
-
- Challenges encountered and solutions applied
|
|
9794
|
-
- Any "lessons learned" or notes for future stories
|
|
9795
|
-
- Extract relevant insights that might inform the current story's preparation
|
|
9850
|
+
**For Backend/API Stories, additionally:** data-models.md, database-schema.md, backend-architecture.md, rest-api-spec.md, external-apis.md
|
|
9796
9851
|
|
|
9797
|
-
|
|
9852
|
+
**For Frontend/UI Stories, additionally:** frontend-architecture.md, components.md, core-workflows.md, data-models.md
|
|
9798
9853
|
|
|
9799
|
-
|
|
9854
|
+
**For Full-Stack Stories:** Read both Backend and Frontend sections above
|
|
9800
9855
|
|
|
9801
|
-
####
|
|
9856
|
+
#### 3.3 Extract Story-Specific Technical Details
|
|
9802
9857
|
|
|
9803
|
-
|
|
9858
|
+
Extract ONLY information directly relevant to implementing the current story. Do NOT invent new libraries, patterns, or standards not in the source documents.
|
|
9804
9859
|
|
|
9805
|
-
|
|
9806
|
-
- Read `{architectureShardedLocation}/index.md` to understand available documentation
|
|
9807
|
-
- Follow the structured reading order in section 4.2 below
|
|
9808
|
-
|
|
9809
|
-
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
|
9810
|
-
- Load the monolithic architecture from `architectureFile`
|
|
9811
|
-
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
|
9812
|
-
|
|
9813
|
-
- **If `architectureVersion` is NOT v4**:
|
|
9814
|
-
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
|
9815
|
-
- If `architectureSharded: true`: Search sharded files by filename relevance
|
|
9816
|
-
- If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
|
|
9817
|
-
|
|
9818
|
-
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
|
|
9819
|
-
|
|
9820
|
-
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
|
|
9821
|
-
|
|
9822
|
-
**For ALL Stories:**
|
|
9823
|
-
|
|
9824
|
-
1. `docs/architecture/tech-stack.md` - Understand technology constraints and versions
|
|
9825
|
-
2. `docs/architecture/unified-project-structure.md` - Know where code should be placed
|
|
9826
|
-
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
|
|
9827
|
-
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
|
|
9828
|
-
|
|
9829
|
-
**For Backend/API Stories, additionally read:**
|
|
9830
|
-
5. `docs/architecture/data-models.md` - Data structures and validation rules
|
|
9831
|
-
6. `docs/architecture/database-schema.md` - Database design and relationships
|
|
9832
|
-
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
|
|
9833
|
-
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
|
|
9834
|
-
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
|
|
9835
|
-
|
|
9836
|
-
**For Frontend/UI Stories, additionally read:**
|
|
9837
|
-
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
|
|
9838
|
-
6. `docs/architecture/components.md` - Specific component designs
|
|
9839
|
-
7. `docs/architecture/core-workflows.md` - User interaction flows
|
|
9840
|
-
8. `docs/architecture/data-models.md` - Frontend data handling
|
|
9841
|
-
|
|
9842
|
-
**For Full-Stack Stories:**
|
|
9843
|
-
|
|
9844
|
-
- Read both Backend and Frontend sections above
|
|
9845
|
-
|
|
9846
|
-
#### 4.3 Extract Story-Specific Technical Details
|
|
9847
|
-
|
|
9848
|
-
[[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.]]
|
|
9849
|
-
|
|
9850
|
-
For each relevant document, extract:
|
|
9860
|
+
Extract:
|
|
9851
9861
|
|
|
9852
9862
|
- Specific data models, schemas, or structures the story will use
|
|
9853
9863
|
- API endpoints the story must implement or consume
|
|
@@ -9856,33 +9866,22 @@ For each relevant document, extract:
|
|
|
9856
9866
|
- Testing requirements specific to the story's features
|
|
9857
9867
|
- Security or performance considerations affecting the story
|
|
9858
9868
|
|
|
9859
|
-
|
|
9860
|
-
|
|
9861
|
-
[[LLM: ALWAYS cite the source document and section for each technical detail you include. This helps the dev agent verify information if needed.]]
|
|
9869
|
+
ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
9862
9870
|
|
|
9863
|
-
|
|
9871
|
+
### 4. Verify Project Structure Alignment
|
|
9864
9872
|
|
|
9865
|
-
|
|
9873
|
+
- Cross-reference story requirements with Project Structure Guide from `docs/architecture/unified-project-structure.md`
|
|
9874
|
+
- Ensure file paths, component locations, or module names align with defined structures
|
|
9875
|
+
- Document any structural conflicts in "Project Structure Notes" section within the story draft
|
|
9866
9876
|
|
|
9867
|
-
|
|
9868
|
-
- Ensure any file paths, component locations, or module names implied by the story align with defined structures.
|
|
9869
|
-
- Document any structural conflicts, necessary clarifications, or undefined components/paths in a "Project Structure Notes" section within the story draft.
|
|
9877
|
+
### 5. Populate Story Template with Full Context
|
|
9870
9878
|
|
|
9871
|
-
|
|
9872
|
-
|
|
9873
|
-
-
|
|
9874
|
-
-
|
|
9875
|
-
-
|
|
9876
|
-
|
|
9877
|
-
- `Status: Draft`
|
|
9878
|
-
- `Story` (User Story statement from Epic)
|
|
9879
|
-
- `Acceptance Criteria (ACs)` (from Epic, to be refined if needed based on context)
|
|
9880
|
-
- **`Dev Technical Guidance` section (CRITICAL):**
|
|
9881
|
-
|
|
9882
|
-
[[LLM: This section MUST contain ONLY information extracted from the architecture shards. NEVER invent or assume technical details.]]
|
|
9883
|
-
|
|
9884
|
-
- Include ALL relevant technical details gathered from Steps 3 and 4, organized by category:
|
|
9885
|
-
- **Previous Story Insights**: Key learnings or considerations from the previous story
|
|
9879
|
+
- Create new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` using Story Template
|
|
9880
|
+
- Fill in basic story information: Title, Status (Draft), Story statement, Acceptance Criteria from Epic
|
|
9881
|
+
- **`Dev Notes` section (CRITICAL):**
|
|
9882
|
+
- CRITICAL: This section MUST contain ONLY information extracted from architecture documents. NEVER invent or assume technical details.
|
|
9883
|
+
- Include ALL relevant technical details from Steps 2-3, organized by category:
|
|
9884
|
+
- **Previous Story Insights**: Key learnings from previous story
|
|
9886
9885
|
- **Data Models**: Specific schemas, validation rules, relationships [with source references]
|
|
9887
9886
|
- **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
|
|
9888
9887
|
- **Component Specifications**: UI component details, props, state management [with source references]
|
|
@@ -9891,55 +9890,28 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
9891
9890
|
- **Technical Constraints**: Version requirements, performance considerations, security rules
|
|
9892
9891
|
- Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
|
|
9893
9892
|
- If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
|
|
9894
|
-
|
|
9895
9893
|
- **`Tasks / Subtasks` section:**
|
|
9896
|
-
- Generate
|
|
9897
|
-
- Requirements from the Epic
|
|
9898
|
-
- Technical constraints from architecture shards
|
|
9899
|
-
- Project structure from unified-project-structure.md
|
|
9900
|
-
- Testing requirements from testing-strategy.md
|
|
9894
|
+
- Generate detailed, sequential list of technical tasks based ONLY on: Epic Requirements, Story AC, Reviewed Architecture Information
|
|
9901
9895
|
- Each task must reference relevant architecture documentation
|
|
9902
|
-
- Include unit testing as explicit subtasks based on
|
|
9896
|
+
- Include unit testing as explicit subtasks based on the Testing Strategy
|
|
9903
9897
|
- Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
|
|
9904
|
-
- Add notes on project structure alignment or discrepancies found in Step
|
|
9905
|
-
- Prepare content for the "Deviation Analysis" based on any conflicts between epic requirements and architecture constraints.
|
|
9898
|
+
- Add notes on project structure alignment or discrepancies found in Step 4
|
|
9906
9899
|
|
|
9907
|
-
###
|
|
9908
|
-
|
|
9909
|
-
- Execute the Story Draft Checklist against the prepared story
|
|
9910
|
-
- Document any issues or gaps identified
|
|
9911
|
-
- Make necessary adjustments to meet quality standards
|
|
9912
|
-
- Ensure all technical guidance is properly sourced from architecture docs
|
|
9913
|
-
|
|
9914
|
-
### 8. Finalize Story File
|
|
9900
|
+
### 6. Story Draft Completion and Review
|
|
9915
9901
|
|
|
9916
9902
|
- Review all sections for completeness and accuracy
|
|
9917
9903
|
- Verify all source references are included for technical details
|
|
9918
9904
|
- Ensure tasks align with both epic requirements and architecture constraints
|
|
9919
|
-
- Update status to "Draft"
|
|
9920
|
-
-
|
|
9921
|
-
|
|
9922
|
-
|
|
9923
|
-
|
|
9924
|
-
|
|
9925
|
-
|
|
9926
|
-
-
|
|
9927
|
-
-
|
|
9928
|
-
-
|
|
9929
|
-
- Any deviations or conflicts noted between epic and architecture
|
|
9930
|
-
- Recommendations for story review before approval
|
|
9931
|
-
- Next steps: Story should be reviewed by PO for approval before dev work begins
|
|
9932
|
-
|
|
9933
|
-
### 10. Update Workflow Plan (if applicable)
|
|
9934
|
-
|
|
9935
|
-
[[LLM: After successful story creation]]
|
|
9936
|
-
|
|
9937
|
-
- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`:
|
|
9938
|
-
- Call update-workflow-plan task to mark story creation step complete
|
|
9939
|
-
- Parameters: task: create-next-story, step_id: {from plan}, status: complete
|
|
9940
|
-
- If plan shows next step, mention it in completion message
|
|
9941
|
-
|
|
9942
|
-
[[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.]]
|
|
9905
|
+
- Update status to "Draft" and save the story file
|
|
9906
|
+
- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`, call update-workflow-plan task to mark story creation step complete
|
|
9907
|
+
- Execute `tasks/execute-checklist` `checklists/story-draft-checklist`
|
|
9908
|
+
- Provide summary to user including:
|
|
9909
|
+
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
9910
|
+
- Status: Draft
|
|
9911
|
+
- Key technical components included from architecture docs
|
|
9912
|
+
- Any deviations or conflicts noted between epic and architecture
|
|
9913
|
+
- Checklist Results
|
|
9914
|
+
- 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`
|
|
9943
9915
|
==================== END: tasks#create-next-story ====================
|
|
9944
9916
|
|
|
9945
9917
|
==================== START: checklists#story-draft-checklist ====================
|
|
@@ -10084,7 +10056,7 @@ Generate a concise validation report:
|
|
|
10084
10056
|
- What questions would you have?
|
|
10085
10057
|
- What might cause delays or rework?
|
|
10086
10058
|
|
|
10087
|
-
Be pragmatic - perfect documentation doesn't exist
|
|
10059
|
+
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.]]
|
|
10088
10060
|
|
|
10089
10061
|
| Category | Status | Issues |
|
|
10090
10062
|
| ------------------------------------ | ------ | ------ |
|