@mark-gozner/aigile-method 0.4.5

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.
Files changed (143) hide show
  1. package/LICENSE.md +26 -0
  2. package/README.md +300 -0
  3. package/core/agent-teams/team-all.yaml +24 -0
  4. package/core/agent-teams/team-company.yaml +17 -0
  5. package/core/agent-teams/team-enterprise.yaml +17 -0
  6. package/core/agent-teams/team-fullstack.yaml +16 -0
  7. package/core/agent-teams/team-ide-minimal.yaml +10 -0
  8. package/core/agents/aigile-master.md +476 -0
  9. package/core/agents/aigile-orchestrator.agent.md +200 -0
  10. package/core/agents/analyst.md +45 -0
  11. package/core/agents/architect.md +43 -0
  12. package/core/agents/code-tour.agent.md +208 -0
  13. package/core/agents/dev.agent.md +145 -0
  14. package/core/agents/dev.md +130 -0
  15. package/core/agents/expert-react-frontend-engineer.agent.md +741 -0
  16. package/core/agents/pm.md +33 -0
  17. package/core/agents/po.md +35 -0
  18. package/core/agents/qa.md +38 -0
  19. package/core/agents/sm.md +31 -0
  20. package/core/agents/ui-expert.md +39 -0
  21. package/core/agents/ux-expert.md +31 -0
  22. package/core/checklists/architect-checklist.md +246 -0
  23. package/core/checklists/change-checklist.md +182 -0
  24. package/core/checklists/pm-checklist.md +286 -0
  25. package/core/checklists/po-master-checklist.md +291 -0
  26. package/core/checklists/story-dod-checklist.md +94 -0
  27. package/core/checklists/story-draft-checklist.md +153 -0
  28. package/core/core-config.yaml +22 -0
  29. package/core/data/aigile-kb.md +112 -0
  30. package/core/data/brainstorming-techniques.md +73 -0
  31. package/core/data/elicitation-methods.md +42 -0
  32. package/core/data/technical-preferences.md +52 -0
  33. package/core/data/test-levels-framework.md +43 -0
  34. package/core/data/test-priorities-matrix.md +26 -0
  35. package/core/instructions/csharp.instructions.md +656 -0
  36. package/core/instructions/dotnet/csharp.instructions.md +656 -0
  37. package/core/instructions/java/java.instructions.md +67 -0
  38. package/core/instructions/java/spring-boot.instructions.md +122 -0
  39. package/core/instructions/java.instructions.md +67 -0
  40. package/core/instructions/spring-boot.instructions.md +122 -0
  41. package/core/prompts/README.md +11 -0
  42. package/core/prompts/architecture/architecture-blueprint-generator.prompt.md +322 -0
  43. package/core/prompts/architecture/architecture-validation.prompt.md +71 -0
  44. package/core/prompts/architecture/file-tree-generator.prompt.md +405 -0
  45. package/core/prompts/architecture/technical-project-analyze.prompt.md +43 -0
  46. package/core/prompts/architecture-blueprint-generator.prompt.md +322 -0
  47. package/core/prompts/architecture-validation.prompt.md +71 -0
  48. package/core/prompts/code-review.prompt.md +107 -0
  49. package/core/prompts/confluence-in-md.prompt.md +167 -0
  50. package/core/prompts/copilot-instructions-blueprint-generator.prompt.md +294 -0
  51. package/core/prompts/create-implementation-plan.prompt.md +157 -0
  52. package/core/prompts/create-oo-component-documentation.prompt.md +193 -0
  53. package/core/prompts/file-tree-generator.prompt.md +405 -0
  54. package/core/prompts/generate-unit-tests.prompt.md +291 -0
  55. package/core/prompts/java/java-doc.prompt.md +24 -0
  56. package/core/prompts/java/java-junit.prompt.md +64 -0
  57. package/core/prompts/java/junit-5.prompt.md +64 -0
  58. package/core/prompts/java-doc.prompt.md +24 -0
  59. package/core/prompts/java-junit.prompt.md +64 -0
  60. package/core/prompts/junit-5.prompt.md +64 -0
  61. package/core/prompts/release-notes/README.md +11 -0
  62. package/core/prompts/release-notes/release-notes.prompt.md +723 -0
  63. package/core/prompts/release-notes.prompt.md +723 -0
  64. package/core/prompts/technical-project-analyze.prompt.md +43 -0
  65. package/core/tasks/advanced-elicitation.md +119 -0
  66. package/core/tasks/check-story-implemented.md +44 -0
  67. package/core/tasks/code-arch-review-with-github.md +40 -0
  68. package/core/tasks/create-architecture-doc.md +55 -0
  69. package/core/tasks/create-jira-epic-from-confluence.md +70 -0
  70. package/core/tasks/create-jira-story-from-confluence.md +39 -0
  71. package/core/tasks/create-jira-story-from-text.md +39 -0
  72. package/core/tasks/create-next-story.md +35 -0
  73. package/core/tasks/create-prd-doc.md +54 -0
  74. package/core/tasks/create-stories-from-epic.md +66 -0
  75. package/core/tasks/create-tasks-for-story.md +60 -0
  76. package/core/tasks/document-project.md +69 -0
  77. package/core/tasks/execute-checklist.md +37 -0
  78. package/core/tasks/explain-story-from-jira.md +44 -0
  79. package/core/tasks/facilitate-brainstorming-session.md +69 -0
  80. package/core/tasks/figma-audit-design-system.md +20 -0
  81. package/core/tasks/front-end-spec-from-design.md +33 -0
  82. package/core/tasks/gate.md +64 -0
  83. package/core/tasks/groom-jira-story.md +52 -0
  84. package/core/tasks/help.md +27 -0
  85. package/core/tasks/implement-freeform-work-item.md +30 -0
  86. package/core/tasks/implement-story-from-jira.md +63 -0
  87. package/core/tasks/implement-unit-tests.md +45 -0
  88. package/core/tasks/market-research-from-context7.md +37 -0
  89. package/core/tasks/review-story.md +30 -0
  90. package/core/tasks/sonarqube-hotspot-review.md +39 -0
  91. package/core/tasks/standup-digest.md +21 -0
  92. package/core/tasks/sync-jira-backlog.md +32 -0
  93. package/core/tasks/test-design.md +68 -0
  94. package/core/tasks/validate-next-story.md +37 -0
  95. package/core/tasks/verify-jira-story-e2e.md +45 -0
  96. package/core/templates/architecture-tmpl.yaml +651 -0
  97. package/core/templates/brainstorming-output-tmpl.yaml +156 -0
  98. package/core/templates/brownfield-architecture-tmpl.yaml +477 -0
  99. package/core/templates/brownfield-prd-tmpl.yaml +281 -0
  100. package/core/templates/front-end-architecture-tmpl.yaml +219 -0
  101. package/core/templates/front-end-spec-tmpl.yaml +350 -0
  102. package/core/templates/fullstack-architecture-tmpl.yaml +824 -0
  103. package/core/templates/market-research-tmpl.yaml +253 -0
  104. package/core/templates/prd-tmpl.yaml +203 -0
  105. package/core/templates/project-brief-tmpl.yaml +222 -0
  106. package/core/templates/qa-gate-tmpl.yaml +103 -0
  107. package/core/templates/story-tmpl.yaml +138 -0
  108. package/core/workflows/brownfield-fullstack.yaml +298 -0
  109. package/core/workflows/brownfield-service.yaml +188 -0
  110. package/core/workflows/brownfield-ui.yaml +198 -0
  111. package/core/workflows/greenfield-fullstack.yaml +241 -0
  112. package/core/workflows/greenfield-service.yaml +207 -0
  113. package/core/workflows/greenfield-ui.yaml +236 -0
  114. package/dist/agents/aigile-master.txt +500 -0
  115. package/dist/agents/aigile-orchestrator.agent.txt +224 -0
  116. package/dist/agents/analyst.txt +69 -0
  117. package/dist/agents/architect.txt +67 -0
  118. package/dist/agents/code-tour.agent.txt +232 -0
  119. package/dist/agents/dev.agent.txt +169 -0
  120. package/dist/agents/dev.txt +154 -0
  121. package/dist/agents/expert-react-frontend-engineer.agent.txt +765 -0
  122. package/dist/agents/pm.txt +57 -0
  123. package/dist/agents/po.txt +59 -0
  124. package/dist/agents/qa.txt +62 -0
  125. package/dist/agents/sm.txt +55 -0
  126. package/dist/agents/ui-expert.txt +63 -0
  127. package/dist/agents/ux-expert.txt +55 -0
  128. package/dist/dev-agent-bundle.txt +154 -0
  129. package/dist/teams/team-company.txt +10789 -0
  130. package/docs/mcp-servers.md +102 -0
  131. package/docs/orchestrator-guide.md +526 -0
  132. package/mcp/servers.json +108 -0
  133. package/mcp/servers.yaml +124 -0
  134. package/package.json +72 -0
  135. package/tools/cli.js +1864 -0
  136. package/tools/installer/README.md +24 -0
  137. package/tools/installer/lib/ide-setup.js +295 -0
  138. package/tools/installer/lib/installer.js +131 -0
  139. package/tools/md-assets/web-agent-startup-instructions.md +21 -0
  140. package/tools/postinstall.js +72 -0
  141. package/tools/shared/bannerArt.js +68 -0
  142. package/tools/validate-bundles.js +54 -0
  143. package/tools/verify-publish-registry.js +34 -0
@@ -0,0 +1,286 @@
1
+ # Product Manager (PM) Requirements Checklist
2
+
3
+ This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.
4
+
5
+ [[LLM: INITIALIZATION INSTRUCTIONS - PM CHECKLIST
6
+
7
+ Before proceeding with this checklist, ensure you have access to:
8
+
9
+ 1. prd.md - The Product Requirements Document (check docs/prd.md)
10
+ 2. Any user research, market analysis, or competitive analysis documents
11
+ 3. Business goals and strategy documents
12
+ 4. Any existing epic definitions or user stories
13
+
14
+ IMPORTANT: If the PRD is missing, immediately ask the user for its location or content before proceeding.
15
+
16
+ VALIDATION APPROACH:
17
+
18
+ 1. User-Centric - Every requirement should tie back to user value
19
+ 2. MVP Focus - Ensure scope is truly minimal while viable
20
+ 3. Clarity - Requirements should be unambiguous and testable
21
+ 4. Completeness - All aspects of the product vision are covered
22
+ 5. Feasibility - Requirements are technically achievable
23
+
24
+ EXECUTION MODE:
25
+ Ask the user if they want to work through the checklist:
26
+
27
+ - Section by section (interactive mode) - Review each section, present findings, get confirmation before proceeding
28
+ - All at once (comprehensive mode) - Complete full analysis and present comprehensive report at end]]
29
+
30
+ ## 1. PROBLEM DEFINITION & CONTEXT
31
+
32
+ [[LLM: The foundation of any product is a clear problem statement. As you review this section:
33
+
34
+ 1. Verify the problem is real and worth solving
35
+ 2. Check that the target audience is specific, not "everyone"
36
+ 3. Ensure success metrics are measurable, not vague aspirations
37
+ 4. Look for evidence of user research, not just assumptions
38
+ 5. Confirm the problem-solution fit is logical]]
39
+
40
+ ### 1.1 Problem Statement
41
+
42
+ - [ ] Clear articulation of the problem being solved
43
+ - [ ] Identification of who experiences the problem
44
+ - [ ] Explanation of why solving this problem matters
45
+ - [ ] Quantification of problem impact (if possible)
46
+ - [ ] Differentiation from existing solutions
47
+
48
+ ### 1.2 Business Goals & Success Metrics
49
+
50
+ - [ ] Specific, measurable business objectives defined
51
+ - [ ] Clear success metrics and KPIs established
52
+ - [ ] Metrics are tied to user and business value
53
+ - [ ] Baseline measurements identified (if applicable)
54
+ - [ ] Timeframe for achieving goals specified
55
+
56
+ ### 1.3 User Research & Insights
57
+
58
+ - [ ] Target user personas clearly defined
59
+ - [ ] User needs and pain points documented
60
+ - [ ] User research findings summarized (if available)
61
+ - [ ] Competitive analysis included
62
+ - [ ] Market context provided
63
+
64
+ ## 2. MVP SCOPE DEFINITION
65
+
66
+ [[LLM: MVP scope is critical - too much and you waste resources, too little and you can't validate. Check:
67
+
68
+ 1. Is this truly minimal? Challenge every feature
69
+ 2. Does each feature directly address the core problem?
70
+ 3. Are "nice-to-haves" clearly separated from "must-haves"?
71
+ 4. Is the rationale for inclusion/exclusion documented?
72
+ 5. Can you ship this in the target timeframe?]]
73
+
74
+ ### 2.1 Core Functionality
75
+
76
+ - [ ] Essential features clearly distinguished from nice-to-haves
77
+ - [ ] Features directly address defined problem statement
78
+ - [ ] Each Epic ties back to specific user needs
79
+ - [ ] Features and Stories are described from user perspective
80
+ - [ ] Minimum requirements for success defined
81
+
82
+ ### 2.2 Scope Boundaries
83
+
84
+ - [ ] Clear articulation of what is OUT of scope
85
+ - [ ] Future enhancements section included
86
+ - [ ] Rationale for scope decisions documented
87
+ - [ ] MVP minimizes functionality while maximizing learning
88
+ - [ ] Scope has been reviewed and refined multiple times
89
+
90
+ ### 2.3 MVP Validation Approach
91
+
92
+ - [ ] Method for testing MVP success defined
93
+ - [ ] Initial user feedback mechanisms planned
94
+ - [ ] Criteria for moving beyond MVP specified
95
+ - [ ] Learning goals for MVP articulated
96
+ - [ ] Timeline expectations set
97
+
98
+ ## 3. USER EXPERIENCE REQUIREMENTS
99
+
100
+ [[LLM: UX requirements bridge user needs and technical implementation. Validate:
101
+
102
+ 1. User flows cover the primary use cases completely
103
+ 2. Edge cases are identified (even if deferred)
104
+ 3. Accessibility isn't an afterthought
105
+ 4. Performance expectations are realistic
106
+ 5. Error states and recovery are planned]]
107
+
108
+ ### 3.1 User Journeys & Flows
109
+
110
+ - [ ] Primary user flows documented
111
+ - [ ] Entry and exit points for each flow identified
112
+ - [ ] Decision points and branches mapped
113
+ - [ ] Critical path highlighted
114
+ - [ ] Edge cases considered
115
+
116
+ ### 3.2 Usability Requirements
117
+
118
+ - [ ] Accessibility considerations documented
119
+ - [ ] Platform/device compatibility specified
120
+ - [ ] Performance expectations from user perspective defined
121
+ - [ ] Error handling and recovery approaches outlined
122
+ - [ ] User feedback mechanisms identified
123
+
124
+ ### 3.3 UI Requirements
125
+
126
+ - [ ] Information architecture outlined
127
+ - [ ] Critical UI components identified
128
+ - [ ] Visual design guidelines referenced (if applicable)
129
+ - [ ] Content requirements specified
130
+ - [ ] High-level navigation structure defined
131
+
132
+ ## 4. FUNCTIONAL REQUIREMENTS
133
+
134
+ [[LLM: Functional requirements must be clear enough for implementation. Check:
135
+
136
+ 1. Requirements focus on WHAT not HOW (no implementation details)
137
+ 2. Each requirement is testable (how would QA verify it?)
138
+ 3. Dependencies are explicit (what needs to be built first?)
139
+ 4. Requirements use consistent terminology
140
+ 5. Complex features are broken into manageable pieces]]
141
+
142
+ ### 4.1 Feature Completeness
143
+
144
+ - [ ] All required features for MVP documented
145
+ - [ ] Features have clear, user-focused descriptions
146
+ - [ ] Feature priority/criticality indicated
147
+ - [ ] Requirements are testable and verifiable
148
+ - [ ] Dependencies between features identified
149
+
150
+ ### 4.2 Requirements Quality
151
+
152
+ - [ ] Requirements are specific and unambiguous
153
+ - [ ] Requirements focus on WHAT not HOW
154
+ - [ ] Requirements use consistent terminology
155
+ - [ ] Complex requirements broken into simpler parts
156
+ - [ ] Technical jargon minimized or explained
157
+
158
+ ### 4.3 User Stories & Acceptance Criteria
159
+
160
+ - [ ] Stories follow consistent format
161
+ - [ ] Acceptance criteria are testable
162
+ - [ ] Stories are sized appropriately (not too large)
163
+ - [ ] Stories are independent where possible
164
+ - [ ] Stories include necessary context
165
+ - [ ] Local testability requirements (e.g., via CLI) defined in ACs for relevant backend/data stories
166
+
167
+ ## 5. NON-FUNCTIONAL REQUIREMENTS
168
+
169
+ ### 5.1 Performance Requirements
170
+
171
+ - [ ] Response time expectations defined
172
+ - [ ] Throughput/capacity requirements specified
173
+ - [ ] Scalability needs documented
174
+ - [ ] Resource utilization constraints identified
175
+ - [ ] Load handling expectations set
176
+
177
+ ### 5.2 Security & Compliance
178
+
179
+ - [ ] Data protection requirements specified
180
+ - [ ] Authentication/authorization needs defined
181
+ - [ ] Compliance requirements documented
182
+ - [ ] Security testing requirements outlined
183
+ - [ ] Privacy considerations addressed
184
+
185
+ ### 5.3 Reliability & Resilience
186
+
187
+ - [ ] Availability requirements defined
188
+ - [ ] Backup and recovery needs documented
189
+ - [ ] Fault tolerance expectations set
190
+ - [ ] Error handling requirements specified
191
+ - [ ] Maintenance and support considerations included
192
+
193
+ ### 5.4 Technical Constraints
194
+
195
+ - [ ] Platform/technology constraints documented
196
+ - [ ] Integration requirements outlined
197
+ - [ ] Third-party service dependencies identified
198
+ - [ ] Infrastructure requirements specified
199
+ - [ ] Development environment needs identified
200
+
201
+ ## 6. EPIC & STORY STRUCTURE
202
+
203
+ ### 6.1 Epic Definition
204
+
205
+ - [ ] Epics represent cohesive units of functionality
206
+ - [ ] Epics focus on user/business value delivery
207
+ - [ ] Epic goals clearly articulated
208
+ - [ ] Epics are sized appropriately for incremental delivery
209
+ - [ ] Epic sequence and dependencies identified
210
+
211
+ ### 6.2 Story Breakdown
212
+
213
+ - [ ] Stories are broken down to appropriate size
214
+ - [ ] Stories have clear, independent value
215
+ - [ ] Stories include appropriate acceptance criteria
216
+ - [ ] Story dependencies and sequence documented
217
+ - [ ] Stories aligned with epic goals
218
+
219
+ ### 6.3 First Epic Completeness
220
+
221
+ - [ ] First epic includes all necessary setup steps
222
+ - [ ] Project scaffolding and initialization addressed
223
+ - [ ] Core infrastructure setup included
224
+ - [ ] Development environment setup addressed
225
+ - [ ] Local testability established early
226
+
227
+ ## 7. TECHNICAL GUIDANCE
228
+
229
+ ### 7.1 Architecture Guidance
230
+
231
+ - [ ] Initial architecture direction provided
232
+ - [ ] Technical constraints clearly communicated
233
+ - [ ] Integration points identified
234
+ - [ ] Performance considerations highlighted
235
+ - [ ] Security requirements articulated
236
+ - [ ] Known areas of high complexity or technical risk flagged for architectural deep-dive
237
+
238
+ ### 7.2 Technical Decision Framework
239
+
240
+ - [ ] Decision criteria for technical choices provided
241
+ - [ ] Trade-offs articulated for key decisions
242
+ - [ ] Rationale for selecting primary approach over considered alternatives documented (for key design/feature choices)
243
+ - [ ] Non-negotiable technical requirements highlighted
244
+ - [ ] Areas requiring technical investigation identified
245
+ - [ ] Guidance on technical debt approach provided
246
+
247
+ ### 7.3 Implementation Considerations
248
+
249
+ - [ ] Development approach guidance provided
250
+ - [ ] Testing requirements articulated
251
+ - [ ] Deployment expectations set
252
+ - [ ] Quality gates defined
253
+ - [ ] Definition of done criteria established
254
+
255
+ ## FINAL PM VALIDATION
256
+
257
+ [[LLM: FINAL PM VALIDATION REPORT
258
+
259
+ After completing the checklist, provide a comprehensive validation report:
260
+
261
+ 1. PRD Assessment
262
+ - PRD readiness: COMPLETE / NEEDS REVISION / INCOMPLETE
263
+ - Scope clarity: CLEAR / PARTIALLY CLEAR / UNCLEAR
264
+ - Technical feasibility: FEASIBLE / CHALLENGING / HIGH RISK
265
+
266
+ 2. Critical Issues (if any)
267
+ - List any items that MUST be resolved before development
268
+ - Specify the impact of each issue
269
+ - Recommend specific actions
270
+
271
+ 3. Epic & Story Readiness
272
+ - Can development begin with current epic definitions?
273
+ - Are stories sufficiently detailed?
274
+ - Are dependencies clear?
275
+
276
+ 4. Recommendations
277
+ - Suggested improvements or clarifications needed
278
+ - Areas requiring special attention
279
+ - Risk mitigation strategies
280
+
281
+ Be thorough but practical - perfect requirements don't exist, but they must be sufficient for successful implementation.]]
282
+
283
+ - [ ] All critical PRD components have been validated
284
+ - [ ] Epic structure supports incremental delivery
285
+ - [ ] Requirements are clear and testable
286
+ - [ ] MVP scope is appropriate and achievable
@@ -0,0 +1,291 @@
1
+ # Product Owner (PO) Master Validation Checklist
2
+
3
+ This checklist serves as a comprehensive framework for the Product Owner to validate project plans before development execution. It adapts intelligently based on project type (greenfield vs brownfield) and includes UI/UX considerations when applicable.
4
+
5
+ [[LLM: INITIALIZATION INSTRUCTIONS - PO MASTER CHECKLIST
6
+
7
+ PROJECT TYPE DETECTION:
8
+ First, determine the project type by checking:
9
+
10
+ 1. Is this a GREENFIELD project (new from scratch)?
11
+ - Look for: New project initialization, no existing codebase references
12
+ - Check for: prd.md, architecture.md, new project setup stories
13
+
14
+ 2. Is this a BROWNFIELD project (enhancing existing system)?
15
+ - Look for: References to existing codebase, enhancement/modification language
16
+ - Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
17
+
18
+ 3. Does the project include UI/UX components?
19
+ - Check for: frontend-architecture.md, UI/UX specifications, design files
20
+ - Look for: Frontend stories, component specifications, user interface mentions
21
+
22
+ DOCUMENT REQUIREMENTS:
23
+ Based on project type, ensure you have access to:
24
+
25
+ For GREENFIELD projects:
26
+ - prd.md - The Product Requirements Document
27
+ - architecture.md - The system architecture
28
+ - frontend-architecture.md - If UI/UX is involved
29
+ - All epic and story definitions
30
+
31
+ For BROWNFIELD projects:
32
+ - brownfield-prd.md - The brownfield enhancement requirements
33
+ - brownfield-architecture.md - The enhancement architecture
34
+ - Existing project codebase access (CRITICAL - cannot proceed without this)
35
+ - Current deployment configuration and infrastructure details
36
+
37
+ SKIP INSTRUCTIONS:
38
+ - Skip sections marked [[BROWNFIELD ONLY]] for greenfield projects
39
+ - Skip sections marked [[GREENFIELD ONLY]] for brownfield projects
40
+ - Skip sections marked [[UI/UX ONLY]] for backend-only projects
41
+ - Note all skipped sections in your final report
42
+
43
+ VALIDATION APPROACH:
44
+ 1. Deep Analysis - Thoroughly analyze each item against documentation
45
+ 2. Evidence-Based - Cite specific sections when validating
46
+ 3. Critical Thinking - Question assumptions and identify gaps
47
+ 4. Risk Assessment - Consider what could go wrong with each decision
48
+
49
+ EXECUTION MODE:
50
+ Ask the user if they want to work through the checklist:
51
+ - Section by section (interactive mode) - Review each section, get confirmation before proceeding
52
+ - All at once (comprehensive mode) - Complete full analysis and present report at end]]
53
+
54
+ ## 1. PROJECT SETUP & INITIALIZATION
55
+
56
+ [[LLM: Project setup is the foundation. For greenfield, ensure clean start. For brownfield, ensure safe integration with existing system. Verify setup matches project type.]]
57
+
58
+ ### 1.1 Project Scaffolding [[GREENFIELD ONLY]]
59
+
60
+ - [ ] Epic 1 includes explicit steps for project creation/initialization
61
+ - [ ] If using a starter template, steps for cloning/setup are included
62
+ - [ ] If building from scratch, all necessary scaffolding steps are defined
63
+ - [ ] Initial README or documentation setup is included
64
+ - [ ] Repository setup and initial commit processes are defined
65
+
66
+ ### 1.2 Existing System Integration [[BROWNFIELD ONLY]]
67
+
68
+ - [ ] Existing project analysis has been completed and documented
69
+ - [ ] Integration points with current system are identified
70
+ - [ ] Development environment preserves existing functionality
71
+ - [ ] Local testing approach validated for existing features
72
+ - [ ] Rollback procedures defined for each integration point
73
+
74
+ ### 1.3 Development Environment
75
+
76
+ - [ ] Local development environment setup is clearly defined
77
+ - [ ] Required tools and versions are specified
78
+ - [ ] Steps for installing dependencies are included
79
+ - [ ] Configuration files are addressed appropriately
80
+ - [ ] Development server setup is included
81
+
82
+ ### 1.4 Core Dependencies
83
+
84
+ - [ ] All critical packages/libraries are installed early
85
+ - [ ] Package management is properly addressed
86
+ - [ ] Version specifications are appropriately defined
87
+ - [ ] Dependency conflicts or special requirements are noted
88
+ - [ ] [[BROWNFIELD ONLY]] Version compatibility with existing stack verified
89
+
90
+ ## 2. INFRASTRUCTURE & DEPLOYMENT
91
+
92
+ [[LLM: Infrastructure must exist before use. For brownfield, must integrate with existing infrastructure without breaking it.]]
93
+
94
+ ### 2.1 Database & Data Store Setup
95
+
96
+ - [ ] Database selection/setup occurs before any operations
97
+ - [ ] Schema definitions are created before data operations
98
+ - [ ] Migration strategies are defined if applicable
99
+ - [ ] Seed data or initial data setup is included if needed
100
+ - [ ] [[BROWNFIELD ONLY]] Database migration risks identified and mitigated
101
+ - [ ] [[BROWNFIELD ONLY]] Backward compatibility ensured
102
+
103
+ ### 2.2 API & Service Configuration
104
+
105
+ - [ ] API frameworks are set up before implementing endpoints
106
+ - [ ] Service architecture is established before implementing services
107
+ - [ ] Authentication framework is set up before protected routes
108
+ - [ ] Middleware and common utilities are created before use
109
+ - [ ] [[BROWNFIELD ONLY]] API compatibility with existing system maintained
110
+ - [ ] [[BROWNFIELD ONLY]] Integration with existing authentication preserved
111
+
112
+ ### 2.3 Deployment Pipeline
113
+
114
+ - [ ] CI/CD pipeline is established before deployment actions
115
+ - [ ] Infrastructure as Code (IaC) is set up before use
116
+ - [ ] Environment configurations are defined early
117
+ - [ ] Deployment strategies are defined before implementation
118
+ - [ ] [[BROWNFIELD ONLY]] Deployment minimizes downtime
119
+ - [ ] [[BROWNFIELD ONLY]] Blue-green or canary deployment implemented
120
+
121
+ ### 2.4 Testing Infrastructure
122
+
123
+ - [ ] Testing frameworks are installed before writing tests
124
+ - [ ] Test environment setup precedes test implementation
125
+ - [ ] Mock services or data are defined before testing
126
+ - [ ] [[BROWNFIELD ONLY]] Regression testing covers existing functionality
127
+ - [ ] [[BROWNFIELD ONLY]] Integration testing validates new-to-existing connections
128
+
129
+ ## 3. EXTERNAL DEPENDENCIES & INTEGRATIONS
130
+
131
+ [[LLM: External dependencies often block progress. For brownfield, ensure new dependencies don't conflict with existing ones.]]
132
+
133
+ ### 3.1 Third-Party Services
134
+
135
+ - [ ] Account creation steps are identified for required services
136
+ - [ ] API key acquisition processes are defined
137
+ - [ ] Steps for securely storing credentials are included
138
+ - [ ] Fallback or offline development options are considered
139
+ - [ ] [[BROWNFIELD ONLY]] Compatibility with existing services verified
140
+ - [ ] [[BROWNFIELD ONLY]] Impact on existing integrations assessed
141
+
142
+ ### 3.2 External APIs
143
+
144
+ - [ ] Integration points with external APIs are clearly identified
145
+ - [ ] Authentication with external services is properly sequenced
146
+ - [ ] API limits or constraints are acknowledged
147
+ - [ ] Backup strategies for API failures are considered
148
+ - [ ] [[BROWNFIELD ONLY]] Existing API dependencies maintained
149
+
150
+ ### 3.3 Infrastructure Services
151
+
152
+ - [ ] Cloud resource provisioning is properly sequenced
153
+ - [ ] DNS or domain registration needs are identified
154
+ - [ ] Email or messaging service setup is included if needed
155
+ - [ ] CDN or static asset hosting setup precedes their use
156
+ - [ ] [[BROWNFIELD ONLY]] Existing infrastructure services preserved
157
+
158
+ ## 4. UI/UX CONSIDERATIONS [[UI/UX ONLY]]
159
+
160
+ [[LLM: Only evaluate this section if the project includes user interface components. Skip entirely for backend-only projects.]]
161
+
162
+ ### 4.1 Design System Setup
163
+
164
+ - [ ] UI framework and libraries are selected and installed early
165
+ - [ ] Design system or component library is established
166
+ - [ ] Styling approach (CSS modules, styled-components, etc.) is defined
167
+ - [ ] Responsive design strategy is established
168
+ - [ ] Accessibility requirements are defined upfront
169
+
170
+ ### 4.2 Frontend Infrastructure
171
+
172
+ - [ ] Frontend build pipeline is configured before development
173
+ - [ ] Asset optimization strategy is defined
174
+ - [ ] Frontend testing framework is set up
175
+ - [ ] Component development workflow is established
176
+ - [ ] [[BROWNFIELD ONLY]] UI consistency with existing system maintained
177
+
178
+ ### 4.3 User Experience Flow
179
+
180
+ - [ ] User journeys are mapped before implementation
181
+ - [ ] Navigation patterns are defined early
182
+ - [ ] Error states and loading states are planned
183
+ - [ ] Form validation patterns are established
184
+ - [ ] [[BROWNFIELD ONLY]] Existing user workflows preserved or migrated
185
+
186
+ ## 5. USER/AGENT RESPONSIBILITY
187
+
188
+ [[LLM: Clear ownership prevents confusion. Ensure tasks are assigned appropriately based on what only humans can do.]]
189
+
190
+ ### 5.1 User Actions
191
+
192
+ - [ ] User responsibilities limited to human-only tasks
193
+ - [ ] Account creation on external services assigned to users
194
+ - [ ] Purchasing or payment actions assigned to users
195
+ - [ ] Credential provision appropriately assigned to users
196
+
197
+ ### 5.2 Developer Agent Actions
198
+
199
+ - [ ] All code-related tasks assigned to developer agents
200
+ - [ ] Automated processes identified as agent responsibilities
201
+ - [ ] Configuration management properly assigned
202
+ - [ ] Testing and validation assigned to appropriate agents
203
+
204
+ ## 6. FEATURE SEQUENCING & DEPENDENCIES
205
+
206
+ [[LLM: Dependencies create the critical path. For brownfield, ensure new features don't break existing ones.]]
207
+
208
+ ### 6.1 Functional Dependencies
209
+
210
+ - [ ] Features depending on others are sequenced correctly
211
+ - [ ] Shared components are built before their use
212
+ - [ ] API endpoints are created before frontend consumption
213
+ - [ ] Database schemas are established before data operations
214
+ - [ ] Authentication is set up before protected features
215
+
216
+ ### 6.2 Epic Sequencing
217
+
218
+ - [ ] Epic dependencies are clearly mapped
219
+ - [ ] Epic sequence supports incremental value delivery
220
+ - [ ] High-risk or complex epics are appropriately positioned
221
+ - [ ] Learning and validation opportunities are maximized
222
+ - [ ] [[BROWNFIELD ONLY]] Integration complexity is managed across epics
223
+
224
+ ### 6.3 Story Dependencies
225
+
226
+ - [ ] Cross-story dependencies are identified and documented
227
+ - [ ] Stories within epics are appropriately sequenced
228
+ - [ ] Blocking dependencies are highlighted
229
+ - [ ] Optional dependencies are clearly marked
230
+ - [ ] Circular dependencies are avoided
231
+
232
+ ## 7. QUALITY & VALIDATION
233
+
234
+ [[LLM: Quality gates ensure we ship working software. For brownfield, ensure we don't break what's working.]]
235
+
236
+ ### 7.1 Testing Strategy
237
+
238
+ - [ ] Testing approach is defined for each story type
239
+ - [ ] Unit testing requirements are clear
240
+ - [ ] Integration testing approach is specified
241
+ - [ ] End-to-end testing strategy is defined (if applicable)
242
+ - [ ] [[BROWNFIELD ONLY]] Regression testing covers critical paths
243
+
244
+ ### 7.2 Quality Gates
245
+
246
+ - [ ] Definition of done criteria are established
247
+ - [ ] Code review processes are defined
248
+ - [ ] Automated quality checks are specified
249
+ - [ ] Performance benchmarks are established (if applicable)
250
+ - [ ] Security validation requirements are defined
251
+
252
+ ### 7.3 Acceptance Criteria
253
+
254
+ - [ ] All stories have clear acceptance criteria
255
+ - [ ] Acceptance criteria are testable and specific
256
+ - [ ] Edge cases are addressed in acceptance criteria
257
+ - [ ] Error handling requirements are specified
258
+ - [ ] Performance criteria are included where relevant
259
+
260
+ ## FINAL PO VALIDATION
261
+
262
+ [[LLM: FINAL PO VALIDATION REPORT
263
+
264
+ After completing the checklist, provide a comprehensive validation report:
265
+
266
+ 1. Project Readiness
267
+ - Overall readiness: READY / NEEDS REVISION / BLOCKED
268
+ - Risk level: LOW / MEDIUM / HIGH
269
+ - Complexity assessment: SIMPLE / MODERATE / COMPLEX
270
+
271
+ 2. Critical Issues (if any)
272
+ - List any items that MUST be resolved before development
273
+ - Specify the impact of each issue
274
+ - Recommend specific actions
275
+
276
+ 3. Epic & Story Assessment
277
+ - Are epics properly sequenced?
278
+ - Are stories sufficiently detailed?
279
+ - Are dependencies clear and manageable?
280
+
281
+ 4. Recommendations
282
+ - Suggested improvements or optimizations
283
+ - Areas requiring special attention during development
284
+ - Risk mitigation strategies
285
+
286
+ Be thorough but practical - perfect planning doesn't exist, but the plan must be sufficient for successful execution.]]
287
+
288
+ - [ ] All critical project components have been validated
289
+ - [ ] Epic and story structure supports successful delivery
290
+ - [ ] Dependencies are identified and manageable
291
+ - [ ] Quality gates are established and appropriate
@@ -0,0 +1,94 @@
1
+ # Story Definition of Done (DoD) Checklist
2
+
3
+ ## Instructions for Developer Agent
4
+
5
+ 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.
6
+
7
+ [[LLM: INITIALIZATION INSTRUCTIONS - STORY DOD VALIDATION
8
+
9
+ This checklist is for DEVELOPER AGENTS to self-validate their work before marking a story complete.
10
+
11
+ 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.
12
+
13
+ EXECUTION APPROACH:
14
+
15
+ 1. Go through each section systematically
16
+ 2. Mark items as [x] Done, [ ] Not Done, or [N/A] Not Applicable
17
+ 3. Add brief comments explaining any [ ] or [N/A] items
18
+ 4. Be specific about what was actually implemented
19
+ 5. Flag any concerns or technical debt created
20
+
21
+ The goal is quality delivery, not just checking boxes.]]
22
+
23
+ ## Checklist Items
24
+
25
+ 1. **Requirements Met:**
26
+
27
+ [[LLM: Be specific - list each requirement and whether it's complete]]
28
+ - [ ] All functional requirements specified in the story are implemented.
29
+ - [ ] All acceptance criteria defined in the story are met.
30
+
31
+ 2. **Coding Standards & Project Structure:**
32
+
33
+ [[LLM: Code quality matters for maintainability. Check each item carefully]]
34
+ - [ ] All new/modified code strictly adheres to `Operational Guidelines`.
35
+ - [ ] All new/modified code aligns with `Project Structure` (file locations, naming, etc.).
36
+ - [ ] Adherence to `Tech Stack` for technologies/versions used (if story introduces or modifies tech usage).
37
+ - [ ] Adherence to `Api Reference` and `Data Models` (if story involves API or data model changes).
38
+ - [ ] Basic security best practices (e.g., input validation, proper error handling, no hardcoded secrets) applied for new/modified code.
39
+ - [ ] No new linter errors or warnings introduced.
40
+ - [ ] Code is well-commented where necessary (clarifying complex logic, not obvious statements).
41
+
42
+ 3. **Testing:**
43
+
44
+ [[LLM: Testing proves your code works. Be honest about test coverage]]
45
+ - [ ] All required unit tests as per the story and `Operational Guidelines` Testing Strategy are implemented.
46
+ - [ ] All required integration tests (if applicable) as per the story and `Operational Guidelines` Testing Strategy are implemented.
47
+ - [ ] All tests (unit, integration, E2E if applicable) pass successfully.
48
+ - [ ] Test coverage meets project standards (if defined).
49
+
50
+ 4. **Functionality & Verification:**
51
+
52
+ [[LLM: Did you actually run and test your code? Be specific about what you tested]]
53
+ - [ ] Functionality has been manually verified by the developer (e.g., running the app locally, checking UI, testing API endpoints).
54
+ - [ ] Edge cases and potential error conditions considered and handled gracefully.
55
+
56
+ 5. **Story Administration:**
57
+
58
+ [[LLM: Documentation helps the next developer. What should they know?]]
59
+ - [ ] All tasks within the story file are marked as complete.
60
+ - [ ] Any clarifications or decisions made during development are documented in the story file or linked appropriately.
61
+ - [ ] 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.
62
+
63
+ 6. **Dependencies, Build & Configuration:**
64
+
65
+ [[LLM: Build issues block everyone. Ensure everything compiles and runs cleanly]]
66
+ - [ ] Project builds successfully without errors.
67
+ - [ ] Project linting passes
68
+ - [ ] 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).
69
+ - [ ] If new dependencies were added, they are recorded in the appropriate project files (e.g., `package.json`, `requirements.txt`) with justification.
70
+ - [ ] No known security vulnerabilities introduced by newly added and approved dependencies.
71
+ - [ ] If new environment variables or configurations were introduced by the story, they are documented and handled securely.
72
+
73
+ 7. **Documentation (If Applicable):**
74
+
75
+ [[LLM: Good documentation prevents future confusion. What needs explaining?]]
76
+ - [ ] Relevant inline code documentation (e.g., JSDoc, TSDoc, Python docstrings) for new public APIs or complex logic is complete.
77
+ - [ ] User-facing documentation updated, if changes impact users.
78
+ - [ ] Technical documentation (e.g., READMEs, system diagrams) updated if significant architectural changes were made.
79
+
80
+ ## Final Confirmation
81
+
82
+ [[LLM: FINAL DOD SUMMARY
83
+
84
+ After completing the checklist:
85
+
86
+ 1. Summarize what was accomplished in this story
87
+ 2. List any items marked as [ ] Not Done with explanations
88
+ 3. Identify any technical debt or follow-up work needed
89
+ 4. Note any challenges or learnings for future stories
90
+ 5. Confirm whether the story is truly ready for review
91
+
92
+ Be honest - it's better to flag issues now than have them discovered later.]]
93
+
94
+ - [ ] I, the Developer Agent, confirm that all applicable items above have been addressed.