siesa-agents 2.1.2 → 2.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -83
- package/bin/install.js +400 -400
- package/bin/prepare-publish.js +26 -26
- package/bin/restore-folders.js +26 -26
- package/bmad-core/agent-teams/team-all.yaml +15 -15
- package/bmad-core/agent-teams/team-fullstack.yaml +19 -19
- package/bmad-core/agent-teams/team-ide-minimal.yaml +11 -11
- package/bmad-core/agent-teams/team-no-ui.yaml +14 -14
- package/bmad-core/agents/analyst.md +84 -84
- package/bmad-core/agents/architect.md +94 -94
- package/bmad-core/agents/backend-agent.md +189 -189
- package/bmad-core/agents/bmad-master.md +110 -110
- package/bmad-core/agents/bmad-orchestrator.md +147 -147
- package/bmad-core/agents/dev.md +81 -81
- package/bmad-core/agents/frontend-agent.md +168 -168
- package/bmad-core/agents/pm.md +84 -84
- package/bmad-core/agents/po.md +79 -79
- package/bmad-core/agents/qa.md +91 -91
- package/bmad-core/agents/sm.md +65 -65
- package/bmad-core/agents/ux-expert.md +69 -69
- package/bmad-core/checklists/architect-checklist.md +440 -440
- package/bmad-core/checklists/backend-checklist.md +142 -142
- package/bmad-core/checklists/change-checklist.md +184 -184
- package/bmad-core/checklists/frontend-checklist.md +105 -105
- package/bmad-core/checklists/pm-checklist.md +372 -372
- package/bmad-core/checklists/po-master-checklist.md +434 -434
- package/bmad-core/checklists/story-dod-checklist.md +96 -96
- package/bmad-core/checklists/story-draft-checklist.md +155 -155
- package/bmad-core/core-config.yaml +22 -22
- package/bmad-core/data/backend-standards.md +439 -439
- package/bmad-core/data/bmad-kb.md +809 -809
- package/bmad-core/data/brainstorming-techniques.md +38 -38
- package/bmad-core/data/elicitation-methods.md +156 -156
- package/bmad-core/data/frontend-standards.md +323 -323
- package/bmad-core/data/technical-preferences.md +5 -5
- package/bmad-core/data/test-levels-framework.md +148 -148
- package/bmad-core/data/test-priorities-matrix.md +174 -174
- package/bmad-core/enhanced-ide-development-workflow.md +248 -248
- package/bmad-core/install-manifest.yaml +230 -230
- package/bmad-core/tasks/advanced-elicitation.md +119 -119
- package/bmad-core/tasks/apply-qa-fixes.md +150 -150
- package/bmad-core/tasks/brownfield-create-epic.md +162 -162
- package/bmad-core/tasks/brownfield-create-story.md +149 -149
- package/bmad-core/tasks/correct-course.md +72 -72
- package/bmad-core/tasks/create-brownfield-story.md +314 -314
- package/bmad-core/tasks/create-component.md +102 -102
- package/bmad-core/tasks/create-deep-research-prompt.md +280 -280
- package/bmad-core/tasks/create-doc.md +103 -103
- package/bmad-core/tasks/create-entity.md +132 -132
- package/bmad-core/tasks/create-feature.md +90 -90
- package/bmad-core/tasks/create-next-story.md +114 -114
- package/bmad-core/tasks/create-service.md +117 -117
- package/bmad-core/tasks/create-use-case.md +140 -140
- package/bmad-core/tasks/document-project.md +345 -345
- package/bmad-core/tasks/execute-checklist.md +88 -88
- package/bmad-core/tasks/facilitate-brainstorming-session.md +138 -138
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +53 -53
- package/bmad-core/tasks/index-docs.md +175 -175
- package/bmad-core/tasks/kb-mode-interaction.md +77 -77
- package/bmad-core/tasks/nfr-assess.md +345 -345
- package/bmad-core/tasks/qa-gate.md +163 -163
- package/bmad-core/tasks/review-story.md +316 -316
- package/bmad-core/tasks/risk-profile.md +355 -355
- package/bmad-core/tasks/scaffold-backend.md +110 -110
- package/bmad-core/tasks/scaffold-frontend.md +78 -78
- package/bmad-core/tasks/shard-doc.md +187 -187
- package/bmad-core/tasks/test-design.md +176 -176
- package/bmad-core/tasks/trace-requirements.md +266 -266
- package/bmad-core/tasks/validate-next-story.md +136 -136
- package/bmad-core/templates/architecture-tmpl.yaml +662 -662
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +156 -156
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +477 -477
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +281 -281
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +307 -307
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +258 -258
- package/bmad-core/templates/front-end-spec-tmpl.yaml +350 -350
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +824 -824
- package/bmad-core/templates/market-research-tmpl.yaml +253 -253
- package/bmad-core/templates/prd-tmpl.yaml +203 -203
- package/bmad-core/templates/project-brief-tmpl.yaml +222 -222
- package/bmad-core/templates/qa-gate-tmpl.yaml +103 -103
- package/bmad-core/templates/story-tmpl.yaml +138 -138
- package/bmad-core/user-guide.md +530 -530
- package/bmad-core/utils/bmad-doc-template.md +327 -327
- package/bmad-core/utils/workflow-management.md +71 -71
- package/bmad-core/workflows/brownfield-fullstack.yaml +298 -298
- package/bmad-core/workflows/brownfield-service.yaml +188 -188
- package/bmad-core/workflows/brownfield-ui.yaml +198 -198
- package/bmad-core/workflows/greenfield-fullstack.yaml +241 -241
- package/bmad-core/workflows/greenfield-service.yaml +207 -207
- package/bmad-core/workflows/greenfield-ui.yaml +236 -236
- package/bmad-core/working-in-the-brownfield.md +606 -606
- package/claude/commands/BMad/agents/backend.md +187 -187
- package/claude/commands/BMad/agents/frontend.md +150 -150
- package/github/b-mad-expert.md +742 -742
- package/github/chatmodes/analyst.chatmode.md +89 -89
- package/github/chatmodes/architect.chatmode.md +97 -97
- package/github/chatmodes/backend.chatmode.md +194 -194
- package/github/chatmodes/bmad-master.chatmode.md +115 -115
- package/github/chatmodes/bmad-orchestrator.chatmode.md +152 -152
- package/github/chatmodes/dev.chatmode.md +86 -86
- package/github/chatmodes/frontend.chatmode.md +157 -157
- package/github/chatmodes/pm.chatmode.md +89 -89
- package/github/chatmodes/po.chatmode.md +84 -84
- package/github/chatmodes/qa.chatmode.md +96 -96
- package/github/chatmodes/sm.chatmode.md +70 -70
- package/github/chatmodes/ux-expert.chatmode.md +74 -74
- package/index.js +9 -9
- package/package.json +37 -37
- package/vscode/mcp.json +11 -11
- package/vscode/settings.json +12 -12
|
@@ -1,96 +1,96 @@
|
|
|
1
|
-
<!-- Powered by BMAD™ Core -->
|
|
2
|
-
|
|
3
|
-
# Story Definition of Done (DoD) Checklist
|
|
4
|
-
|
|
5
|
-
## Instructions for Developer Agent
|
|
6
|
-
|
|
7
|
-
Before marking a story as 'Review', please go through each item in this checklist. Report the status of each item (e.g., [x] Done, [ ] Not Done, [N/A] Not Applicable) and provide brief comments if necessary.
|
|
8
|
-
|
|
9
|
-
[[LLM: INITIALIZATION INSTRUCTIONS - STORY DOD VALIDATION
|
|
10
|
-
|
|
11
|
-
This checklist is for DEVELOPER AGENTS to self-validate their work before marking a story complete.
|
|
12
|
-
|
|
13
|
-
IMPORTANT: This is a self-assessment. Be honest about what's actually done vs what should be done. It's better to identify issues now than have them found in review.
|
|
14
|
-
|
|
15
|
-
EXECUTION APPROACH:
|
|
16
|
-
|
|
17
|
-
1. Go through each section systematically
|
|
18
|
-
2. Mark items as [x] Done, [ ] Not Done, or [N/A] Not Applicable
|
|
19
|
-
3. Add brief comments explaining any [ ] or [N/A] items
|
|
20
|
-
4. Be specific about what was actually implemented
|
|
21
|
-
5. Flag any concerns or technical debt created
|
|
22
|
-
|
|
23
|
-
The goal is quality delivery, not just checking boxes.]]
|
|
24
|
-
|
|
25
|
-
## Checklist Items
|
|
26
|
-
|
|
27
|
-
1. **Requirements Met:**
|
|
28
|
-
|
|
29
|
-
[[LLM: Be specific - list each requirement and whether it's complete]]
|
|
30
|
-
- [ ] All functional requirements specified in the story are implemented.
|
|
31
|
-
- [ ] All acceptance criteria defined in the story are met.
|
|
32
|
-
|
|
33
|
-
2. **Coding Standards & Project Structure:**
|
|
34
|
-
|
|
35
|
-
[[LLM: Code quality matters for maintainability. Check each item carefully]]
|
|
36
|
-
- [ ] All new/modified code strictly adheres to `Operational Guidelines`.
|
|
37
|
-
- [ ] All new/modified code aligns with `Project Structure` (file locations, naming, etc.).
|
|
38
|
-
- [ ] Adherence to `Tech Stack` for technologies/versions used (if story introduces or modifies tech usage).
|
|
39
|
-
- [ ] Adherence to `Api Reference` and `Data Models` (if story involves API or data model changes).
|
|
40
|
-
- [ ] Basic security best practices (e.g., input validation, proper error handling, no hardcoded secrets) applied for new/modified code.
|
|
41
|
-
- [ ] No new linter errors or warnings introduced.
|
|
42
|
-
- [ ] Code is well-commented where necessary (clarifying complex logic, not obvious statements).
|
|
43
|
-
|
|
44
|
-
3. **Testing:**
|
|
45
|
-
|
|
46
|
-
[[LLM: Testing proves your code works. Be honest about test coverage]]
|
|
47
|
-
- [ ] All required unit tests as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
48
|
-
- [ ] All required integration tests (if applicable) as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
49
|
-
- [ ] All tests (unit, integration, E2E if applicable) pass successfully.
|
|
50
|
-
- [ ] Test coverage meets project standards (if defined).
|
|
51
|
-
|
|
52
|
-
4. **Functionality & Verification:**
|
|
53
|
-
|
|
54
|
-
[[LLM: Did you actually run and test your code? Be specific about what you tested]]
|
|
55
|
-
- [ ] Functionality has been manually verified by the developer (e.g., running the app locally, checking UI, testing API endpoints).
|
|
56
|
-
- [ ] Edge cases and potential error conditions considered and handled gracefully.
|
|
57
|
-
|
|
58
|
-
5. **Story Administration:**
|
|
59
|
-
|
|
60
|
-
[[LLM: Documentation helps the next developer. What should they know?]]
|
|
61
|
-
- [ ] All tasks within the story file are marked as complete.
|
|
62
|
-
- [ ] Any clarifications or decisions made during development are documented in the story file or linked appropriately.
|
|
63
|
-
- [ ] The story wrap up section has been completed with notes of changes or information relevant to the next story or overall project, the agent model that was primarily used during development, and the changelog of any changes is properly updated.
|
|
64
|
-
|
|
65
|
-
6. **Dependencies, Build & Configuration:**
|
|
66
|
-
|
|
67
|
-
[[LLM: Build issues block everyone. Ensure everything compiles and runs cleanly]]
|
|
68
|
-
- [ ] Project builds successfully without errors.
|
|
69
|
-
- [ ] Project linting passes
|
|
70
|
-
- [ ] Any new dependencies added were either pre-approved in the story requirements OR explicitly approved by the user during development (approval documented in story file).
|
|
71
|
-
- [ ] If new dependencies were added, they are recorded in the appropriate project files (e.g., `package.json`, `requirements.txt`) with justification.
|
|
72
|
-
- [ ] No known security vulnerabilities introduced by newly added and approved dependencies.
|
|
73
|
-
- [ ] If new environment variables or configurations were introduced by the story, they are documented and handled securely.
|
|
74
|
-
|
|
75
|
-
7. **Documentation (If Applicable):**
|
|
76
|
-
|
|
77
|
-
[[LLM: Good documentation prevents future confusion. What needs explaining?]]
|
|
78
|
-
- [ ] Relevant inline code documentation (e.g., JSDoc, TSDoc, Python docstrings) for new public APIs or complex logic is complete.
|
|
79
|
-
- [ ] User-facing documentation updated, if changes impact users.
|
|
80
|
-
- [ ] Technical documentation (e.g., READMEs, system diagrams) updated if significant architectural changes were made.
|
|
81
|
-
|
|
82
|
-
## Final Confirmation
|
|
83
|
-
|
|
84
|
-
[[LLM: FINAL DOD SUMMARY
|
|
85
|
-
|
|
86
|
-
After completing the checklist:
|
|
87
|
-
|
|
88
|
-
1. Summarize what was accomplished in this story
|
|
89
|
-
2. List any items marked as [ ] Not Done with explanations
|
|
90
|
-
3. Identify any technical debt or follow-up work needed
|
|
91
|
-
4. Note any challenges or learnings for future stories
|
|
92
|
-
5. Confirm whether the story is truly ready for review
|
|
93
|
-
|
|
94
|
-
Be honest - it's better to flag issues now than have them discovered later.]]
|
|
95
|
-
|
|
96
|
-
- [ ] I, the Developer Agent, confirm that all applicable items above have been addressed.
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
3
|
+
# Story Definition of Done (DoD) Checklist
|
|
4
|
+
|
|
5
|
+
## Instructions for Developer Agent
|
|
6
|
+
|
|
7
|
+
Before marking a story as 'Review', please go through each item in this checklist. Report the status of each item (e.g., [x] Done, [ ] Not Done, [N/A] Not Applicable) and provide brief comments if necessary.
|
|
8
|
+
|
|
9
|
+
[[LLM: INITIALIZATION INSTRUCTIONS - STORY DOD VALIDATION
|
|
10
|
+
|
|
11
|
+
This checklist is for DEVELOPER AGENTS to self-validate their work before marking a story complete.
|
|
12
|
+
|
|
13
|
+
IMPORTANT: This is a self-assessment. Be honest about what's actually done vs what should be done. It's better to identify issues now than have them found in review.
|
|
14
|
+
|
|
15
|
+
EXECUTION APPROACH:
|
|
16
|
+
|
|
17
|
+
1. Go through each section systematically
|
|
18
|
+
2. Mark items as [x] Done, [ ] Not Done, or [N/A] Not Applicable
|
|
19
|
+
3. Add brief comments explaining any [ ] or [N/A] items
|
|
20
|
+
4. Be specific about what was actually implemented
|
|
21
|
+
5. Flag any concerns or technical debt created
|
|
22
|
+
|
|
23
|
+
The goal is quality delivery, not just checking boxes.]]
|
|
24
|
+
|
|
25
|
+
## Checklist Items
|
|
26
|
+
|
|
27
|
+
1. **Requirements Met:**
|
|
28
|
+
|
|
29
|
+
[[LLM: Be specific - list each requirement and whether it's complete]]
|
|
30
|
+
- [ ] All functional requirements specified in the story are implemented.
|
|
31
|
+
- [ ] All acceptance criteria defined in the story are met.
|
|
32
|
+
|
|
33
|
+
2. **Coding Standards & Project Structure:**
|
|
34
|
+
|
|
35
|
+
[[LLM: Code quality matters for maintainability. Check each item carefully]]
|
|
36
|
+
- [ ] All new/modified code strictly adheres to `Operational Guidelines`.
|
|
37
|
+
- [ ] All new/modified code aligns with `Project Structure` (file locations, naming, etc.).
|
|
38
|
+
- [ ] Adherence to `Tech Stack` for technologies/versions used (if story introduces or modifies tech usage).
|
|
39
|
+
- [ ] Adherence to `Api Reference` and `Data Models` (if story involves API or data model changes).
|
|
40
|
+
- [ ] Basic security best practices (e.g., input validation, proper error handling, no hardcoded secrets) applied for new/modified code.
|
|
41
|
+
- [ ] No new linter errors or warnings introduced.
|
|
42
|
+
- [ ] Code is well-commented where necessary (clarifying complex logic, not obvious statements).
|
|
43
|
+
|
|
44
|
+
3. **Testing:**
|
|
45
|
+
|
|
46
|
+
[[LLM: Testing proves your code works. Be honest about test coverage]]
|
|
47
|
+
- [ ] All required unit tests as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
48
|
+
- [ ] All required integration tests (if applicable) as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
49
|
+
- [ ] All tests (unit, integration, E2E if applicable) pass successfully.
|
|
50
|
+
- [ ] Test coverage meets project standards (if defined).
|
|
51
|
+
|
|
52
|
+
4. **Functionality & Verification:**
|
|
53
|
+
|
|
54
|
+
[[LLM: Did you actually run and test your code? Be specific about what you tested]]
|
|
55
|
+
- [ ] Functionality has been manually verified by the developer (e.g., running the app locally, checking UI, testing API endpoints).
|
|
56
|
+
- [ ] Edge cases and potential error conditions considered and handled gracefully.
|
|
57
|
+
|
|
58
|
+
5. **Story Administration:**
|
|
59
|
+
|
|
60
|
+
[[LLM: Documentation helps the next developer. What should they know?]]
|
|
61
|
+
- [ ] All tasks within the story file are marked as complete.
|
|
62
|
+
- [ ] Any clarifications or decisions made during development are documented in the story file or linked appropriately.
|
|
63
|
+
- [ ] The story wrap up section has been completed with notes of changes or information relevant to the next story or overall project, the agent model that was primarily used during development, and the changelog of any changes is properly updated.
|
|
64
|
+
|
|
65
|
+
6. **Dependencies, Build & Configuration:**
|
|
66
|
+
|
|
67
|
+
[[LLM: Build issues block everyone. Ensure everything compiles and runs cleanly]]
|
|
68
|
+
- [ ] Project builds successfully without errors.
|
|
69
|
+
- [ ] Project linting passes
|
|
70
|
+
- [ ] Any new dependencies added were either pre-approved in the story requirements OR explicitly approved by the user during development (approval documented in story file).
|
|
71
|
+
- [ ] If new dependencies were added, they are recorded in the appropriate project files (e.g., `package.json`, `requirements.txt`) with justification.
|
|
72
|
+
- [ ] No known security vulnerabilities introduced by newly added and approved dependencies.
|
|
73
|
+
- [ ] If new environment variables or configurations were introduced by the story, they are documented and handled securely.
|
|
74
|
+
|
|
75
|
+
7. **Documentation (If Applicable):**
|
|
76
|
+
|
|
77
|
+
[[LLM: Good documentation prevents future confusion. What needs explaining?]]
|
|
78
|
+
- [ ] Relevant inline code documentation (e.g., JSDoc, TSDoc, Python docstrings) for new public APIs or complex logic is complete.
|
|
79
|
+
- [ ] User-facing documentation updated, if changes impact users.
|
|
80
|
+
- [ ] Technical documentation (e.g., READMEs, system diagrams) updated if significant architectural changes were made.
|
|
81
|
+
|
|
82
|
+
## Final Confirmation
|
|
83
|
+
|
|
84
|
+
[[LLM: FINAL DOD SUMMARY
|
|
85
|
+
|
|
86
|
+
After completing the checklist:
|
|
87
|
+
|
|
88
|
+
1. Summarize what was accomplished in this story
|
|
89
|
+
2. List any items marked as [ ] Not Done with explanations
|
|
90
|
+
3. Identify any technical debt or follow-up work needed
|
|
91
|
+
4. Note any challenges or learnings for future stories
|
|
92
|
+
5. Confirm whether the story is truly ready for review
|
|
93
|
+
|
|
94
|
+
Be honest - it's better to flag issues now than have them discovered later.]]
|
|
95
|
+
|
|
96
|
+
- [ ] I, the Developer Agent, confirm that all applicable items above have been addressed.
|
|
@@ -1,155 +1,155 @@
|
|
|
1
|
-
<!-- Powered by BMAD™ Core -->
|
|
2
|
-
|
|
3
|
-
# Story Draft Checklist
|
|
4
|
-
|
|
5
|
-
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.
|
|
6
|
-
|
|
7
|
-
[[LLM: INITIALIZATION INSTRUCTIONS - STORY DRAFT VALIDATION
|
|
8
|
-
|
|
9
|
-
Before proceeding with this checklist, ensure you have access to:
|
|
10
|
-
|
|
11
|
-
1. The story document being validated (usually in docs/stories/ or provided directly)
|
|
12
|
-
2. The parent epic context
|
|
13
|
-
3. Any referenced architecture or design documents
|
|
14
|
-
4. Previous related stories if this builds on prior work
|
|
15
|
-
|
|
16
|
-
IMPORTANT: This checklist validates individual stories BEFORE implementation begins.
|
|
17
|
-
|
|
18
|
-
VALIDATION PRINCIPLES:
|
|
19
|
-
|
|
20
|
-
1. Clarity - A developer should understand WHAT to build
|
|
21
|
-
2. Context - WHY this is being built and how it fits
|
|
22
|
-
3. Guidance - Key technical decisions and patterns to follow
|
|
23
|
-
4. Testability - How to verify the implementation works
|
|
24
|
-
5. Self-Contained - Most info needed is in the story itself
|
|
25
|
-
|
|
26
|
-
REMEMBER: We assume competent developer agents who can:
|
|
27
|
-
|
|
28
|
-
- Research documentation and codebases
|
|
29
|
-
- Make reasonable technical decisions
|
|
30
|
-
- Follow established patterns
|
|
31
|
-
- Ask for clarification when truly stuck
|
|
32
|
-
|
|
33
|
-
We're checking for SUFFICIENT guidance, not exhaustive detail.]]
|
|
34
|
-
|
|
35
|
-
## 1. GOAL & CONTEXT CLARITY
|
|
36
|
-
|
|
37
|
-
[[LLM: Without clear goals, developers build the wrong thing. Verify:
|
|
38
|
-
|
|
39
|
-
1. The story states WHAT functionality to implement
|
|
40
|
-
2. The business value or user benefit is clear
|
|
41
|
-
3. How this fits into the larger epic/product is explained
|
|
42
|
-
4. Dependencies are explicit ("requires Story X to be complete")
|
|
43
|
-
5. Success looks like something specific, not vague]]
|
|
44
|
-
|
|
45
|
-
- [ ] Story goal/purpose is clearly stated
|
|
46
|
-
- [ ] Relationship to epic goals is evident
|
|
47
|
-
- [ ] How the story fits into overall system flow is explained
|
|
48
|
-
- [ ] Dependencies on previous stories are identified (if applicable)
|
|
49
|
-
- [ ] Business context and value are clear
|
|
50
|
-
|
|
51
|
-
## 2. TECHNICAL IMPLEMENTATION GUIDANCE
|
|
52
|
-
|
|
53
|
-
[[LLM: Developers need enough technical context to start coding. Check:
|
|
54
|
-
|
|
55
|
-
1. Key files/components to create or modify are mentioned
|
|
56
|
-
2. Technology choices are specified where non-obvious
|
|
57
|
-
3. Integration points with existing code are identified
|
|
58
|
-
4. Data models or API contracts are defined or referenced
|
|
59
|
-
5. Non-standard patterns or exceptions are called out
|
|
60
|
-
|
|
61
|
-
Note: We don't need every file listed - just the important ones.]]
|
|
62
|
-
|
|
63
|
-
- [ ] Key files to create/modify are identified (not necessarily exhaustive)
|
|
64
|
-
- [ ] Technologies specifically needed for this story are mentioned
|
|
65
|
-
- [ ] Critical APIs or interfaces are sufficiently described
|
|
66
|
-
- [ ] Necessary data models or structures are referenced
|
|
67
|
-
- [ ] Required environment variables are listed (if applicable)
|
|
68
|
-
- [ ] Any exceptions to standard coding patterns are noted
|
|
69
|
-
|
|
70
|
-
## 3. REFERENCE EFFECTIVENESS
|
|
71
|
-
|
|
72
|
-
[[LLM: References should help, not create a treasure hunt. Ensure:
|
|
73
|
-
|
|
74
|
-
1. References point to specific sections, not whole documents
|
|
75
|
-
2. The relevance of each reference is explained
|
|
76
|
-
3. Critical information is summarized in the story
|
|
77
|
-
4. References are accessible (not broken links)
|
|
78
|
-
5. Previous story context is summarized if needed]]
|
|
79
|
-
|
|
80
|
-
- [ ] References to external documents point to specific relevant sections
|
|
81
|
-
- [ ] Critical information from previous stories is summarized (not just referenced)
|
|
82
|
-
- [ ] Context is provided for why references are relevant
|
|
83
|
-
- [ ] References use consistent format (e.g., `docs/filename.md#section`)
|
|
84
|
-
|
|
85
|
-
## 4. SELF-CONTAINMENT ASSESSMENT
|
|
86
|
-
|
|
87
|
-
[[LLM: Stories should be mostly self-contained to avoid context switching. Verify:
|
|
88
|
-
|
|
89
|
-
1. Core requirements are in the story, not just in references
|
|
90
|
-
2. Domain terms are explained or obvious from context
|
|
91
|
-
3. Assumptions are stated explicitly
|
|
92
|
-
4. Edge cases are mentioned (even if deferred)
|
|
93
|
-
5. The story could be understood without reading 10 other documents]]
|
|
94
|
-
|
|
95
|
-
- [ ] Core information needed is included (not overly reliant on external docs)
|
|
96
|
-
- [ ] Implicit assumptions are made explicit
|
|
97
|
-
- [ ] Domain-specific terms or concepts are explained
|
|
98
|
-
- [ ] Edge cases or error scenarios are addressed
|
|
99
|
-
|
|
100
|
-
## 5. TESTING GUIDANCE
|
|
101
|
-
|
|
102
|
-
[[LLM: Testing ensures the implementation actually works. Check:
|
|
103
|
-
|
|
104
|
-
1. Test approach is specified (unit, integration, e2e)
|
|
105
|
-
2. Key test scenarios are listed
|
|
106
|
-
3. Success criteria are measurable
|
|
107
|
-
4. Special test considerations are noted
|
|
108
|
-
5. Acceptance criteria in the story are testable]]
|
|
109
|
-
|
|
110
|
-
- [ ] Required testing approach is outlined
|
|
111
|
-
- [ ] Key test scenarios are identified
|
|
112
|
-
- [ ] Success criteria are defined
|
|
113
|
-
- [ ] Special testing considerations are noted (if applicable)
|
|
114
|
-
|
|
115
|
-
## VALIDATION RESULT
|
|
116
|
-
|
|
117
|
-
[[LLM: FINAL STORY VALIDATION REPORT
|
|
118
|
-
|
|
119
|
-
Generate a concise validation report:
|
|
120
|
-
|
|
121
|
-
1. Quick Summary
|
|
122
|
-
- Story readiness: READY / NEEDS REVISION / BLOCKED
|
|
123
|
-
- Clarity score (1-10)
|
|
124
|
-
- Major gaps identified
|
|
125
|
-
|
|
126
|
-
2. Fill in the validation table with:
|
|
127
|
-
- PASS: Requirements clearly met
|
|
128
|
-
- PARTIAL: Some gaps but workable
|
|
129
|
-
- FAIL: Critical information missing
|
|
130
|
-
|
|
131
|
-
3. Specific Issues (if any)
|
|
132
|
-
- List concrete problems to fix
|
|
133
|
-
- Suggest specific improvements
|
|
134
|
-
- Identify any blocking dependencies
|
|
135
|
-
|
|
136
|
-
4. Developer Perspective
|
|
137
|
-
- Could YOU implement this story as written?
|
|
138
|
-
- What questions would you have?
|
|
139
|
-
- What might cause delays or rework?
|
|
140
|
-
|
|
141
|
-
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.]]
|
|
142
|
-
|
|
143
|
-
| Category | Status | Issues |
|
|
144
|
-
| ------------------------------------ | ------ | ------ |
|
|
145
|
-
| 1. Goal & Context Clarity | _TBD_ | |
|
|
146
|
-
| 2. Technical Implementation Guidance | _TBD_ | |
|
|
147
|
-
| 3. Reference Effectiveness | _TBD_ | |
|
|
148
|
-
| 4. Self-Containment Assessment | _TBD_ | |
|
|
149
|
-
| 5. Testing Guidance | _TBD_ | |
|
|
150
|
-
|
|
151
|
-
**Final Assessment:**
|
|
152
|
-
|
|
153
|
-
- READY: The story provides sufficient context for implementation
|
|
154
|
-
- NEEDS REVISION: The story requires updates (see issues)
|
|
155
|
-
- BLOCKED: External information required (specify what information)
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
3
|
+
# Story Draft Checklist
|
|
4
|
+
|
|
5
|
+
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.
|
|
6
|
+
|
|
7
|
+
[[LLM: INITIALIZATION INSTRUCTIONS - STORY DRAFT VALIDATION
|
|
8
|
+
|
|
9
|
+
Before proceeding with this checklist, ensure you have access to:
|
|
10
|
+
|
|
11
|
+
1. The story document being validated (usually in docs/stories/ or provided directly)
|
|
12
|
+
2. The parent epic context
|
|
13
|
+
3. Any referenced architecture or design documents
|
|
14
|
+
4. Previous related stories if this builds on prior work
|
|
15
|
+
|
|
16
|
+
IMPORTANT: This checklist validates individual stories BEFORE implementation begins.
|
|
17
|
+
|
|
18
|
+
VALIDATION PRINCIPLES:
|
|
19
|
+
|
|
20
|
+
1. Clarity - A developer should understand WHAT to build
|
|
21
|
+
2. Context - WHY this is being built and how it fits
|
|
22
|
+
3. Guidance - Key technical decisions and patterns to follow
|
|
23
|
+
4. Testability - How to verify the implementation works
|
|
24
|
+
5. Self-Contained - Most info needed is in the story itself
|
|
25
|
+
|
|
26
|
+
REMEMBER: We assume competent developer agents who can:
|
|
27
|
+
|
|
28
|
+
- Research documentation and codebases
|
|
29
|
+
- Make reasonable technical decisions
|
|
30
|
+
- Follow established patterns
|
|
31
|
+
- Ask for clarification when truly stuck
|
|
32
|
+
|
|
33
|
+
We're checking for SUFFICIENT guidance, not exhaustive detail.]]
|
|
34
|
+
|
|
35
|
+
## 1. GOAL & CONTEXT CLARITY
|
|
36
|
+
|
|
37
|
+
[[LLM: Without clear goals, developers build the wrong thing. Verify:
|
|
38
|
+
|
|
39
|
+
1. The story states WHAT functionality to implement
|
|
40
|
+
2. The business value or user benefit is clear
|
|
41
|
+
3. How this fits into the larger epic/product is explained
|
|
42
|
+
4. Dependencies are explicit ("requires Story X to be complete")
|
|
43
|
+
5. Success looks like something specific, not vague]]
|
|
44
|
+
|
|
45
|
+
- [ ] Story goal/purpose is clearly stated
|
|
46
|
+
- [ ] Relationship to epic goals is evident
|
|
47
|
+
- [ ] How the story fits into overall system flow is explained
|
|
48
|
+
- [ ] Dependencies on previous stories are identified (if applicable)
|
|
49
|
+
- [ ] Business context and value are clear
|
|
50
|
+
|
|
51
|
+
## 2. TECHNICAL IMPLEMENTATION GUIDANCE
|
|
52
|
+
|
|
53
|
+
[[LLM: Developers need enough technical context to start coding. Check:
|
|
54
|
+
|
|
55
|
+
1. Key files/components to create or modify are mentioned
|
|
56
|
+
2. Technology choices are specified where non-obvious
|
|
57
|
+
3. Integration points with existing code are identified
|
|
58
|
+
4. Data models or API contracts are defined or referenced
|
|
59
|
+
5. Non-standard patterns or exceptions are called out
|
|
60
|
+
|
|
61
|
+
Note: We don't need every file listed - just the important ones.]]
|
|
62
|
+
|
|
63
|
+
- [ ] Key files to create/modify are identified (not necessarily exhaustive)
|
|
64
|
+
- [ ] Technologies specifically needed for this story are mentioned
|
|
65
|
+
- [ ] Critical APIs or interfaces are sufficiently described
|
|
66
|
+
- [ ] Necessary data models or structures are referenced
|
|
67
|
+
- [ ] Required environment variables are listed (if applicable)
|
|
68
|
+
- [ ] Any exceptions to standard coding patterns are noted
|
|
69
|
+
|
|
70
|
+
## 3. REFERENCE EFFECTIVENESS
|
|
71
|
+
|
|
72
|
+
[[LLM: References should help, not create a treasure hunt. Ensure:
|
|
73
|
+
|
|
74
|
+
1. References point to specific sections, not whole documents
|
|
75
|
+
2. The relevance of each reference is explained
|
|
76
|
+
3. Critical information is summarized in the story
|
|
77
|
+
4. References are accessible (not broken links)
|
|
78
|
+
5. Previous story context is summarized if needed]]
|
|
79
|
+
|
|
80
|
+
- [ ] References to external documents point to specific relevant sections
|
|
81
|
+
- [ ] Critical information from previous stories is summarized (not just referenced)
|
|
82
|
+
- [ ] Context is provided for why references are relevant
|
|
83
|
+
- [ ] References use consistent format (e.g., `docs/filename.md#section`)
|
|
84
|
+
|
|
85
|
+
## 4. SELF-CONTAINMENT ASSESSMENT
|
|
86
|
+
|
|
87
|
+
[[LLM: Stories should be mostly self-contained to avoid context switching. Verify:
|
|
88
|
+
|
|
89
|
+
1. Core requirements are in the story, not just in references
|
|
90
|
+
2. Domain terms are explained or obvious from context
|
|
91
|
+
3. Assumptions are stated explicitly
|
|
92
|
+
4. Edge cases are mentioned (even if deferred)
|
|
93
|
+
5. The story could be understood without reading 10 other documents]]
|
|
94
|
+
|
|
95
|
+
- [ ] Core information needed is included (not overly reliant on external docs)
|
|
96
|
+
- [ ] Implicit assumptions are made explicit
|
|
97
|
+
- [ ] Domain-specific terms or concepts are explained
|
|
98
|
+
- [ ] Edge cases or error scenarios are addressed
|
|
99
|
+
|
|
100
|
+
## 5. TESTING GUIDANCE
|
|
101
|
+
|
|
102
|
+
[[LLM: Testing ensures the implementation actually works. Check:
|
|
103
|
+
|
|
104
|
+
1. Test approach is specified (unit, integration, e2e)
|
|
105
|
+
2. Key test scenarios are listed
|
|
106
|
+
3. Success criteria are measurable
|
|
107
|
+
4. Special test considerations are noted
|
|
108
|
+
5. Acceptance criteria in the story are testable]]
|
|
109
|
+
|
|
110
|
+
- [ ] Required testing approach is outlined
|
|
111
|
+
- [ ] Key test scenarios are identified
|
|
112
|
+
- [ ] Success criteria are defined
|
|
113
|
+
- [ ] Special testing considerations are noted (if applicable)
|
|
114
|
+
|
|
115
|
+
## VALIDATION RESULT
|
|
116
|
+
|
|
117
|
+
[[LLM: FINAL STORY VALIDATION REPORT
|
|
118
|
+
|
|
119
|
+
Generate a concise validation report:
|
|
120
|
+
|
|
121
|
+
1. Quick Summary
|
|
122
|
+
- Story readiness: READY / NEEDS REVISION / BLOCKED
|
|
123
|
+
- Clarity score (1-10)
|
|
124
|
+
- Major gaps identified
|
|
125
|
+
|
|
126
|
+
2. Fill in the validation table with:
|
|
127
|
+
- PASS: Requirements clearly met
|
|
128
|
+
- PARTIAL: Some gaps but workable
|
|
129
|
+
- FAIL: Critical information missing
|
|
130
|
+
|
|
131
|
+
3. Specific Issues (if any)
|
|
132
|
+
- List concrete problems to fix
|
|
133
|
+
- Suggest specific improvements
|
|
134
|
+
- Identify any blocking dependencies
|
|
135
|
+
|
|
136
|
+
4. Developer Perspective
|
|
137
|
+
- Could YOU implement this story as written?
|
|
138
|
+
- What questions would you have?
|
|
139
|
+
- What might cause delays or rework?
|
|
140
|
+
|
|
141
|
+
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.]]
|
|
142
|
+
|
|
143
|
+
| Category | Status | Issues |
|
|
144
|
+
| ------------------------------------ | ------ | ------ |
|
|
145
|
+
| 1. Goal & Context Clarity | _TBD_ | |
|
|
146
|
+
| 2. Technical Implementation Guidance | _TBD_ | |
|
|
147
|
+
| 3. Reference Effectiveness | _TBD_ | |
|
|
148
|
+
| 4. Self-Containment Assessment | _TBD_ | |
|
|
149
|
+
| 5. Testing Guidance | _TBD_ | |
|
|
150
|
+
|
|
151
|
+
**Final Assessment:**
|
|
152
|
+
|
|
153
|
+
- READY: The story provides sufficient context for implementation
|
|
154
|
+
- NEEDS REVISION: The story requires updates (see issues)
|
|
155
|
+
- BLOCKED: External information required (specify what information)
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
markdownExploder: true
|
|
2
|
-
qa:
|
|
3
|
-
qaLocation: docs/qa
|
|
4
|
-
prd:
|
|
5
|
-
prdFile: docs/prd.md
|
|
6
|
-
prdVersion: v4
|
|
7
|
-
prdSharded: true
|
|
8
|
-
prdShardedLocation: docs/prd
|
|
9
|
-
epicFilePattern: epic-{n}*.md
|
|
10
|
-
architecture:
|
|
11
|
-
architectureFile: docs/architecture.md
|
|
12
|
-
architectureVersion: v4
|
|
13
|
-
architectureSharded: true
|
|
14
|
-
architectureShardedLocation: docs/architecture
|
|
15
|
-
customTechnicalDocuments: null
|
|
16
|
-
devLoadAlwaysFiles:
|
|
17
|
-
- docs/architecture/coding-standards.md
|
|
18
|
-
- docs/architecture/tech-stack.md
|
|
19
|
-
- docs/architecture/source-tree.md
|
|
20
|
-
devDebugLog: .ai/debug-log.md
|
|
21
|
-
devStoryLocation: docs/stories
|
|
22
|
-
slashPrefix: BMad
|
|
1
|
+
markdownExploder: true
|
|
2
|
+
qa:
|
|
3
|
+
qaLocation: docs/qa
|
|
4
|
+
prd:
|
|
5
|
+
prdFile: docs/prd.md
|
|
6
|
+
prdVersion: v4
|
|
7
|
+
prdSharded: true
|
|
8
|
+
prdShardedLocation: docs/prd
|
|
9
|
+
epicFilePattern: epic-{n}*.md
|
|
10
|
+
architecture:
|
|
11
|
+
architectureFile: docs/architecture.md
|
|
12
|
+
architectureVersion: v4
|
|
13
|
+
architectureSharded: true
|
|
14
|
+
architectureShardedLocation: docs/architecture
|
|
15
|
+
customTechnicalDocuments: null
|
|
16
|
+
devLoadAlwaysFiles:
|
|
17
|
+
- docs/architecture/coding-standards.md
|
|
18
|
+
- docs/architecture/tech-stack.md
|
|
19
|
+
- docs/architecture/source-tree.md
|
|
20
|
+
devDebugLog: .ai/debug-log.md
|
|
21
|
+
devStoryLocation: docs/stories
|
|
22
|
+
slashPrefix: BMad
|