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/agents/analyst.txt
CHANGED
|
@@ -77,11 +77,13 @@ startup:
|
|
|
77
77
|
- Greet the user with your name and role, and inform of the *help command.
|
|
78
78
|
commands:
|
|
79
79
|
- help: Show numbered list of the following commands to allow selection
|
|
80
|
-
-
|
|
81
|
-
-
|
|
80
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
81
|
+
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
|
82
|
+
- doc-out: Output full document to current destination file
|
|
83
|
+
- execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
|
|
84
|
+
- research {topic}: execute task create-deep-research-prompt for architectural decisions
|
|
82
85
|
- brainstorm {topic}: Facilitate structured brainstorming session
|
|
83
|
-
-
|
|
84
|
-
- elicit: Run advanced elicitation to clarify requirements
|
|
86
|
+
- elicit: list the options under output set of information
|
|
85
87
|
- document-project: Analyze and document existing project structure comprehensively
|
|
86
88
|
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
|
87
89
|
dependencies:
|
|
@@ -1157,9 +1159,11 @@ Apply the advanced elicitation task after major sections to refine based on user
|
|
|
1157
1159
|
==================== END: tasks#document-project ====================
|
|
1158
1160
|
|
|
1159
1161
|
==================== START: templates#project-brief-tmpl ====================
|
|
1160
|
-
|
|
1162
|
+
---
|
|
1163
|
+
defaultOutput: docs/brief.md
|
|
1164
|
+
---
|
|
1161
1165
|
|
|
1162
|
-
|
|
1166
|
+
# Project Brief: {{Project Name}}
|
|
1163
1167
|
|
|
1164
1168
|
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
|
1165
1169
|
|
|
@@ -77,10 +77,11 @@ startup:
|
|
|
77
77
|
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
|
78
78
|
commands:
|
|
79
79
|
- help: Show numbered list of the following commands to allow selection
|
|
80
|
-
-
|
|
81
|
-
-
|
|
82
|
-
-
|
|
83
|
-
-
|
|
80
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
81
|
+
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
|
82
|
+
- doc-out: Output full document to current destination file
|
|
83
|
+
- execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
|
|
84
|
+
- research {topic}: execute task create-deep-research-prompt for architectural decisions
|
|
84
85
|
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
|
|
85
86
|
dependencies:
|
|
86
87
|
tasks:
|
|
@@ -59,36 +59,32 @@ persona:
|
|
|
59
59
|
- Execute any resource directly without persona transformation
|
|
60
60
|
- Load resources at runtime, never pre-load
|
|
61
61
|
- Expert knowledge of all BMad resources
|
|
62
|
-
- Track execution state and guide multi-step
|
|
62
|
+
- Track execution state and guide multi-step plans
|
|
63
63
|
- Use numbered lists for choices
|
|
64
|
-
- Process (*) commands immediately
|
|
64
|
+
- Process (*) commands immediately, All commands require * prefix when used (e.g., *help)
|
|
65
65
|
startup:
|
|
66
66
|
- Greet the user with your name and role, and inform of the *help command.
|
|
67
|
-
- Check for active workflow plan using utils
|
|
68
|
-
-
|
|
69
|
-
-
|
|
70
|
-
- CRITICAL: Do NOT scan filesystem or load any resources during startup
|
|
67
|
+
- Check for active workflow plan using the utils plan-management
|
|
68
|
+
- If plan exists: Show brief status - Active plan {workflow} in progress
|
|
69
|
+
- If plan exists: Suggest next step based on plan
|
|
70
|
+
- CRITICAL: Do NOT scan filesystem or load any resources during startup, ONLY when commanded
|
|
71
71
|
- CRITICAL: Do NOT run discovery tasks automatically
|
|
72
|
-
- Wait for user request before any tool use
|
|
73
|
-
- Match request to resources, offer numbered options if unclear
|
|
74
|
-
- Load resources only when explicitly requested
|
|
75
72
|
commands:
|
|
76
|
-
- help: Show commands
|
|
77
|
-
-
|
|
78
|
-
-
|
|
79
|
-
-
|
|
80
|
-
-
|
|
81
|
-
-
|
|
73
|
+
- help: Show these listed commands in a numbered list
|
|
74
|
+
- kb: Toggle KB mode off (default) or on, when on will load and reference the data/bmad-kb and converse with the user answering his questions with this informational resource
|
|
75
|
+
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
|
|
76
|
+
- list {task|template|util|checklist|workflow}: List resources by type ONLY from the corresponding dependencies sub item below
|
|
77
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
78
|
+
- execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
|
|
79
|
+
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
|
80
|
+
- plan: Execute the task Create workflow plan
|
|
82
81
|
- plan-status: Show current workflow plan progress
|
|
83
82
|
- plan-update: Update workflow plan status
|
|
83
|
+
- yolo: Toggle Yolo Mode off (default) abd on - on will skip doc section confirmations
|
|
84
|
+
- doc-out: Output full document to current destination file
|
|
84
85
|
- exit: Exit (confirm)
|
|
85
|
-
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
|
86
|
-
- doc-out: Output full document
|
|
87
|
-
fuzzy-matching:
|
|
88
|
-
- 85% confidence threshold
|
|
89
|
-
- Show numbered list if unsure
|
|
90
86
|
workflow-guidance:
|
|
91
|
-
- When user asks about workflows, offer: Would you like me to create a workflow plan first? (*plan)
|
|
87
|
+
- When user asks about workflows, offer: (Experimental-Feature) Would you like me to create a workflow plan first? (*plan)
|
|
92
88
|
- For complex projects, suggest planning before execution
|
|
93
89
|
- Plan command maps to create-workflow-plan task
|
|
94
90
|
execution:
|
|
@@ -1890,187 +1886,62 @@ Apply the advanced elicitation task after major sections to refine based on user
|
|
|
1890
1886
|
|
|
1891
1887
|
## Purpose
|
|
1892
1888
|
|
|
1893
|
-
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.
|
|
1889
|
+
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.
|
|
1894
1890
|
|
|
1895
|
-
## Task Execution
|
|
1891
|
+
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
1896
1892
|
|
|
1897
|
-
### 0. Load Core Configuration
|
|
1898
|
-
|
|
1899
|
-
[[LLM: CRITICAL - This MUST be your first step]]
|
|
1893
|
+
### 0. Load Core Configuration and Check Workflow
|
|
1900
1894
|
|
|
1901
1895
|
- Load `.bmad-core/core-config.yaml` from the project root
|
|
1902
|
-
- If the file does not exist:
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
2. Run the BMad installer against your project to upgrade and add the file automatically
|
|
1906
|
-
Please add and configure core-config.yaml before proceeding."
|
|
1907
|
-
- Extract the following key configurations:
|
|
1908
|
-
- `devStoryLocation`: Where to save story files
|
|
1909
|
-
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
|
1910
|
-
- `prd.prdFile`: Location of monolithic PRD (if not sharded)
|
|
1911
|
-
- `prd.prdShardedLocation`: Location of sharded epic files
|
|
1912
|
-
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
|
1913
|
-
- `architecture.architectureVersion`: Architecture document version
|
|
1914
|
-
- `architecture.architectureSharded`: Whether architecture is sharded
|
|
1915
|
-
- `architecture.architectureFile`: Location of monolithic architecture
|
|
1916
|
-
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
|
1917
|
-
- `workflow.trackProgress`: Whether workflow plan tracking is enabled
|
|
1918
|
-
- `workflow.planFile`: Location of workflow plan (if tracking enabled)
|
|
1919
|
-
|
|
1920
|
-
### 0.5 Check Workflow Plan (if configured)
|
|
1921
|
-
|
|
1922
|
-
[[LLM: Check if workflow plan tracking is enabled]]
|
|
1923
|
-
|
|
1924
|
-
- If `workflow.trackProgress: true`, check for active plan at `workflow.planFile`
|
|
1925
|
-
- If plan exists:
|
|
1926
|
-
- Parse plan to check if story creation is the expected next step
|
|
1927
|
-
- If out of sequence and `workflow.enforceSequence: true`:
|
|
1928
|
-
- Show warning: "The workflow plan indicates you should complete {expected_step} before creating stories."
|
|
1929
|
-
- Block execution unless user explicitly overrides
|
|
1930
|
-
- If out of sequence and `workflow.enforceSequence: false`:
|
|
1931
|
-
- Show warning but allow continuation with confirmation
|
|
1932
|
-
- Continue with story identification after plan check
|
|
1896
|
+
- 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."
|
|
1897
|
+
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`, `workflow.*`
|
|
1898
|
+
- If `workflow.trackProgress: true`, use `utils/plan-management.md` to check plan sequence and warn if out of order
|
|
1933
1899
|
|
|
1934
1900
|
### 1. Identify Next Story for Preparation
|
|
1935
1901
|
|
|
1936
|
-
#### 1.1 Locate Epic Files
|
|
1937
|
-
|
|
1938
|
-
- Based on `prdSharded` from config:
|
|
1939
|
-
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
|
1940
|
-
- **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
|
|
1941
|
-
|
|
1942
|
-
#### 1.2 Review Existing Stories
|
|
1943
|
-
|
|
1944
|
-
- Check `devStoryLocation` from config (e.g., `docs/stories/`) for existing story files
|
|
1945
|
-
- If the directory exists and has at least 1 file, find the highest-numbered story file.
|
|
1946
|
-
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
|
|
1947
|
-
- Verify its `Status` is 'Done' (or equivalent).
|
|
1948
|
-
- If not 'Done', present an alert to the user:
|
|
1949
|
-
|
|
1950
|
-
```plaintext
|
|
1951
|
-
ALERT: Found incomplete story:
|
|
1952
|
-
File: {lastEpicNum}.{lastStoryNum}.story.md
|
|
1953
|
-
Status: [current status]
|
|
1954
|
-
|
|
1955
|
-
Would you like to:
|
|
1956
|
-
1. View the incomplete story details (instructs user to do so, agent does not display)
|
|
1957
|
-
2. Cancel new story creation at this time
|
|
1958
|
-
3. Accept risk & Override to create the next story in draft
|
|
1959
|
-
|
|
1960
|
-
Please choose an option (1/2/3):
|
|
1961
|
-
```
|
|
1962
|
-
|
|
1963
|
-
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
|
|
1964
|
-
- 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).
|
|
1965
|
-
- If the next sequential story has unmet prerequisites, present this to the user:
|
|
1966
|
-
|
|
1967
|
-
```plaintext
|
|
1968
|
-
ALERT: Next story has unmet prerequisites:
|
|
1969
|
-
Story: {epicNum}.{storyNum} - {Story Title}
|
|
1970
|
-
Prerequisites not met: [list specific prerequisites]
|
|
1971
|
-
|
|
1972
|
-
Would you like to:
|
|
1973
|
-
1. Create the story anyway (mark prerequisites as pending)
|
|
1974
|
-
2. Skip to a different story (requires your specific instruction)
|
|
1975
|
-
3. Cancel story creation
|
|
1976
|
-
|
|
1977
|
-
Please choose an option (1/2/3):
|
|
1978
|
-
```
|
|
1979
|
-
|
|
1980
|
-
- If there are no more stories in the current epic (e.g., 2.9 was done and there is no 2.10):
|
|
1981
|
-
|
|
1982
|
-
```plaintext
|
|
1983
|
-
Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed.
|
|
1984
|
-
|
|
1985
|
-
Would you like to:
|
|
1986
|
-
1. Begin Epic {epicNum + 1} with story {epicNum + 1}.1
|
|
1987
|
-
2. Select a specific story to work on
|
|
1988
|
-
3. Cancel story creation
|
|
1989
|
-
|
|
1990
|
-
Please choose an option (1/2/3):
|
|
1991
|
-
```
|
|
1992
|
-
|
|
1993
|
-
- **CRITICAL**: NEVER automatically skip to another epic or non-sequential story. The user MUST explicitly instruct which story to create if skipping the sequential order.
|
|
1994
|
-
|
|
1995
|
-
- **If no story files exist in `docs/stories/`:**
|
|
1996
|
-
- The next story is ALWAYS 1.1 (the first story of the first epic).
|
|
1997
|
-
- If story 1.1 has unmet prerequisites, follow the same alert process as above.
|
|
1998
|
-
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
|
|
1999
|
-
|
|
2000
|
-
### 2. Gather Core Story Requirements (from Epic)
|
|
1902
|
+
#### 1.1 Locate Epic Files and Review Existing Stories
|
|
2001
1903
|
|
|
2002
|
-
-
|
|
2003
|
-
-
|
|
2004
|
-
-
|
|
1904
|
+
- Based on `prdSharded` from config, locate epic files (sharded location/pattern or monolithic PRD sections)
|
|
1905
|
+
- If `devStoryLocation` has story files, load the highest `{epicNum}.{storyNum}.story.md` file
|
|
1906
|
+
- **If highest story exists:**
|
|
1907
|
+
- 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?"
|
|
1908
|
+
- If proceeding, select next sequential story in the current epic
|
|
1909
|
+
- 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"
|
|
1910
|
+
- **CRITICAL**: NEVER automatically skip to another epic. User MUST explicitly instruct which story to create.
|
|
1911
|
+
- **If no story files exist:** The next story is ALWAYS 1.1 (first story of first epic)
|
|
1912
|
+
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}"
|
|
2005
1913
|
|
|
2006
|
-
###
|
|
1914
|
+
### 2. Gather Story Requirements and Previous Story Context
|
|
2007
1915
|
|
|
2008
|
-
|
|
1916
|
+
- Extract story requirements from the identified epic file
|
|
1917
|
+
- If previous story exists, review Dev Agent Record sections for:
|
|
1918
|
+
- Completion Notes and Debug Log References
|
|
1919
|
+
- Implementation deviations and technical decisions
|
|
1920
|
+
- Challenges encountered and lessons learned
|
|
1921
|
+
- Extract relevant insights that inform the current story's preparation
|
|
2009
1922
|
|
|
2010
|
-
|
|
2011
|
-
- Read the previous sequential story from `docs/stories`
|
|
2012
|
-
- Pay special attention to:
|
|
2013
|
-
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
|
|
2014
|
-
- Any deviations from planned implementation
|
|
2015
|
-
- Technical decisions made during implementation
|
|
2016
|
-
- Challenges encountered and solutions applied
|
|
2017
|
-
- Any "lessons learned" or notes for future stories
|
|
2018
|
-
- Extract relevant insights that might inform the current story's preparation
|
|
1923
|
+
### 3. Gather Architecture Context
|
|
2019
1924
|
|
|
2020
|
-
|
|
1925
|
+
#### 3.1 Determine Architecture Reading Strategy
|
|
2021
1926
|
|
|
2022
|
-
|
|
1927
|
+
- **If `architectureVersion: >= v4` and `architectureSharded: true`**: Read `{architectureShardedLocation}/index.md` then follow structured reading order below
|
|
1928
|
+
- **Else**: Use monolithic `architectureFile` for similar sections
|
|
2023
1929
|
|
|
2024
|
-
####
|
|
1930
|
+
#### 3.2 Read Architecture Documents Based on Story Type
|
|
2025
1931
|
|
|
2026
|
-
|
|
1932
|
+
**For ALL Stories:** tech-stack.md, unified-project-structure.md, coding-standards.md, testing-strategy.md
|
|
2027
1933
|
|
|
2028
|
-
|
|
2029
|
-
- Read `{architectureShardedLocation}/index.md` to understand available documentation
|
|
2030
|
-
- Follow the structured reading order in section 4.2 below
|
|
2031
|
-
|
|
2032
|
-
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
|
2033
|
-
- Load the monolithic architecture from `architectureFile`
|
|
2034
|
-
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
|
2035
|
-
|
|
2036
|
-
- **If `architectureVersion` is NOT v4**:
|
|
2037
|
-
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
|
2038
|
-
- If `architectureSharded: true`: Search sharded files by filename relevance
|
|
2039
|
-
- If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
|
|
1934
|
+
**For Backend/API Stories, additionally:** data-models.md, database-schema.md, backend-architecture.md, rest-api-spec.md, external-apis.md
|
|
2040
1935
|
|
|
2041
|
-
|
|
2042
|
-
|
|
2043
|
-
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
|
|
2044
|
-
|
|
2045
|
-
**For ALL Stories:**
|
|
2046
|
-
|
|
2047
|
-
1. `docs/architecture/tech-stack.md` - Understand technology constraints and versions
|
|
2048
|
-
2. `docs/architecture/unified-project-structure.md` - Know where code should be placed
|
|
2049
|
-
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
|
|
2050
|
-
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
|
|
2051
|
-
|
|
2052
|
-
**For Backend/API Stories, additionally read:**
|
|
2053
|
-
5. `docs/architecture/data-models.md` - Data structures and validation rules
|
|
2054
|
-
6. `docs/architecture/database-schema.md` - Database design and relationships
|
|
2055
|
-
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
|
|
2056
|
-
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
|
|
2057
|
-
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
|
|
1936
|
+
**For Frontend/UI Stories, additionally:** frontend-architecture.md, components.md, core-workflows.md, data-models.md
|
|
2058
1937
|
|
|
2059
|
-
**For
|
|
2060
|
-
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
|
|
2061
|
-
6. `docs/architecture/components.md` - Specific component designs
|
|
2062
|
-
7. `docs/architecture/core-workflows.md` - User interaction flows
|
|
2063
|
-
8. `docs/architecture/data-models.md` - Frontend data handling
|
|
1938
|
+
**For Full-Stack Stories:** Read both Backend and Frontend sections above
|
|
2064
1939
|
|
|
2065
|
-
|
|
1940
|
+
#### 3.3 Extract Story-Specific Technical Details
|
|
2066
1941
|
|
|
2067
|
-
|
|
1942
|
+
Extract ONLY information directly relevant to implementing the current story. Do NOT invent new libraries, patterns, or standards not in the source documents.
|
|
2068
1943
|
|
|
2069
|
-
|
|
2070
|
-
|
|
2071
|
-
[[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.]]
|
|
2072
|
-
|
|
2073
|
-
For each relevant document, extract:
|
|
1944
|
+
Extract:
|
|
2074
1945
|
|
|
2075
1946
|
- Specific data models, schemas, or structures the story will use
|
|
2076
1947
|
- API endpoints the story must implement or consume
|
|
@@ -2079,33 +1950,22 @@ For each relevant document, extract:
|
|
|
2079
1950
|
- Testing requirements specific to the story's features
|
|
2080
1951
|
- Security or performance considerations affecting the story
|
|
2081
1952
|
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
[[LLM: ALWAYS cite the source document and section for each technical detail you include. This helps the dev agent verify information if needed.]]
|
|
2085
|
-
|
|
2086
|
-
Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
2087
|
-
|
|
2088
|
-
### 5. Verify Project Structure Alignment
|
|
1953
|
+
ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
2089
1954
|
|
|
2090
|
-
|
|
2091
|
-
- Ensure any file paths, component locations, or module names implied by the story align with defined structures.
|
|
2092
|
-
- Document any structural conflicts, necessary clarifications, or undefined components/paths in a "Project Structure Notes" section within the story draft.
|
|
1955
|
+
### 4. Verify Project Structure Alignment
|
|
2093
1956
|
|
|
2094
|
-
|
|
1957
|
+
- Cross-reference story requirements with Project Structure Guide from `docs/architecture/unified-project-structure.md`
|
|
1958
|
+
- Ensure file paths, component locations, or module names align with defined structures
|
|
1959
|
+
- Document any structural conflicts in "Project Structure Notes" section within the story draft
|
|
2095
1960
|
|
|
2096
|
-
|
|
2097
|
-
- Use the Story Template to structure the file.
|
|
2098
|
-
- Fill in:
|
|
2099
|
-
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
|
|
2100
|
-
- `Status: Draft`
|
|
2101
|
-
- `Story` (User Story statement from Epic)
|
|
2102
|
-
- `Acceptance Criteria (ACs)` (from Epic, to be refined if needed based on context)
|
|
2103
|
-
- **`Dev Technical Guidance` section (CRITICAL):**
|
|
1961
|
+
### 5. Populate Story Template with Full Context
|
|
2104
1962
|
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
1963
|
+
- Create new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` using Story Template
|
|
1964
|
+
- Fill in basic story information: Title, Status (Draft), Story statement, Acceptance Criteria from Epic
|
|
1965
|
+
- **`Dev Notes` section (CRITICAL):**
|
|
1966
|
+
- CRITICAL: This section MUST contain ONLY information extracted from architecture documents. NEVER invent or assume technical details.
|
|
1967
|
+
- Include ALL relevant technical details from Steps 2-3, organized by category:
|
|
1968
|
+
- **Previous Story Insights**: Key learnings from previous story
|
|
2109
1969
|
- **Data Models**: Specific schemas, validation rules, relationships [with source references]
|
|
2110
1970
|
- **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
|
|
2111
1971
|
- **Component Specifications**: UI component details, props, state management [with source references]
|
|
@@ -2114,55 +1974,28 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
2114
1974
|
- **Technical Constraints**: Version requirements, performance considerations, security rules
|
|
2115
1975
|
- Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
|
|
2116
1976
|
- If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
|
|
2117
|
-
|
|
2118
1977
|
- **`Tasks / Subtasks` section:**
|
|
2119
|
-
- Generate
|
|
2120
|
-
- Requirements from the Epic
|
|
2121
|
-
- Technical constraints from architecture shards
|
|
2122
|
-
- Project structure from unified-project-structure.md
|
|
2123
|
-
- Testing requirements from testing-strategy.md
|
|
1978
|
+
- Generate detailed, sequential list of technical tasks based ONLY on: Epic Requirements, Story AC, Reviewed Architecture Information
|
|
2124
1979
|
- Each task must reference relevant architecture documentation
|
|
2125
|
-
- Include unit testing as explicit subtasks based on
|
|
1980
|
+
- Include unit testing as explicit subtasks based on the Testing Strategy
|
|
2126
1981
|
- Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
|
|
2127
|
-
- Add notes on project structure alignment or discrepancies found in Step
|
|
2128
|
-
- Prepare content for the "Deviation Analysis" based on any conflicts between epic requirements and architecture constraints.
|
|
2129
|
-
|
|
2130
|
-
### 7. Run Story Draft Checklist
|
|
1982
|
+
- Add notes on project structure alignment or discrepancies found in Step 4
|
|
2131
1983
|
|
|
2132
|
-
|
|
2133
|
-
- Document any issues or gaps identified
|
|
2134
|
-
- Make necessary adjustments to meet quality standards
|
|
2135
|
-
- Ensure all technical guidance is properly sourced from architecture docs
|
|
2136
|
-
|
|
2137
|
-
### 8. Finalize Story File
|
|
1984
|
+
### 6. Story Draft Completion and Review
|
|
2138
1985
|
|
|
2139
1986
|
- Review all sections for completeness and accuracy
|
|
2140
1987
|
- Verify all source references are included for technical details
|
|
2141
1988
|
- Ensure tasks align with both epic requirements and architecture constraints
|
|
2142
|
-
- Update status to "Draft"
|
|
2143
|
-
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
|
|
2149
|
-
-
|
|
2150
|
-
-
|
|
2151
|
-
-
|
|
2152
|
-
- Any deviations or conflicts noted between epic and architecture
|
|
2153
|
-
- Recommendations for story review before approval
|
|
2154
|
-
- Next steps: Story should be reviewed by PO for approval before dev work begins
|
|
2155
|
-
|
|
2156
|
-
### 10. Update Workflow Plan (if applicable)
|
|
2157
|
-
|
|
2158
|
-
[[LLM: After successful story creation]]
|
|
2159
|
-
|
|
2160
|
-
- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`:
|
|
2161
|
-
- Call update-workflow-plan task to mark story creation step complete
|
|
2162
|
-
- Parameters: task: create-next-story, step_id: {from plan}, status: complete
|
|
2163
|
-
- If plan shows next step, mention it in completion message
|
|
2164
|
-
|
|
2165
|
-
[[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.]]
|
|
1989
|
+
- Update status to "Draft" and save the story file
|
|
1990
|
+
- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`, call update-workflow-plan task to mark story creation step complete
|
|
1991
|
+
- Execute `tasks/execute-checklist` `checklists/story-draft-checklist`
|
|
1992
|
+
- Provide summary to user including:
|
|
1993
|
+
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
1994
|
+
- Status: Draft
|
|
1995
|
+
- Key technical components included from architecture docs
|
|
1996
|
+
- Any deviations or conflicts noted between epic and architecture
|
|
1997
|
+
- Checklist Results
|
|
1998
|
+
- 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`
|
|
2166
1999
|
==================== END: tasks#create-next-story ====================
|
|
2167
2000
|
|
|
2168
2001
|
==================== START: tasks#execute-checklist ====================
|
|
@@ -6918,9 +6751,11 @@ so that {{benefit}}.
|
|
|
6918
6751
|
==================== END: templates#prd-tmpl ====================
|
|
6919
6752
|
|
|
6920
6753
|
==================== START: templates#project-brief-tmpl ====================
|
|
6921
|
-
|
|
6754
|
+
---
|
|
6755
|
+
defaultOutput: docs/brief.md
|
|
6756
|
+
---
|
|
6922
6757
|
|
|
6923
|
-
|
|
6758
|
+
# Project Brief: {{Project Name}}
|
|
6924
6759
|
|
|
6925
6760
|
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
|
6926
6761
|
|
|
@@ -7151,17 +6986,32 @@ These replace the standard elicitation options when working on project brief doc
|
|
|
7151
6986
|
==================== END: templates#project-brief-tmpl ====================
|
|
7152
6987
|
|
|
7153
6988
|
==================== START: templates#story-tmpl ====================
|
|
6989
|
+
---
|
|
6990
|
+
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
|
6991
|
+
smAgent:
|
|
6992
|
+
editableSections: Status, Story, Acceptance Criteria, Tasks / Subtasks, Dev Notes, Testing, Change Log
|
|
6993
|
+
sectionSpecificInstructions:
|
|
6994
|
+
"Dev Notes":
|
|
6995
|
+
- Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story
|
|
6996
|
+
- Do not invent information.
|
|
6997
|
+
- If known add Relevant Source Tree info that relates to this story.
|
|
6998
|
+
- If there were important notes from previous story that are relevant to this one, include them here.
|
|
6999
|
+
- 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.
|
|
7000
|
+
Testing:
|
|
7001
|
+
- List Relevant Testing Standards from Architecture the Developer needs to conform to (test file location, test standards, etc)
|
|
7002
|
+
---
|
|
7003
|
+
|
|
7154
7004
|
# Story {{EpicNum}}.{{StoryNum}}: {{Short Title Copied from Epic File specific story}}
|
|
7155
7005
|
|
|
7156
7006
|
## Status: {{ Draft | Approved | InProgress | Review | Done }}
|
|
7157
7007
|
|
|
7158
7008
|
## Story
|
|
7159
7009
|
|
|
7160
|
-
|
|
7161
|
-
|
|
7162
|
-
|
|
7010
|
+
**As a** {{role}},\
|
|
7011
|
+
**I want** {{action}},\
|
|
7012
|
+
**so that** {{benefit}}
|
|
7163
7013
|
|
|
7164
|
-
## Acceptance Criteria
|
|
7014
|
+
## Acceptance Criteria
|
|
7165
7015
|
|
|
7166
7016
|
{{ Copy of Acceptance Criteria numbered list }}
|
|
7167
7017
|
|
|
@@ -7176,20 +7026,12 @@ These replace the standard elicitation options when working on project brief doc
|
|
|
7176
7026
|
|
|
7177
7027
|
## Dev Notes
|
|
7178
7028
|
|
|
7179
|
-
[[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.]]
|
|
7180
|
-
|
|
7181
7029
|
### Testing
|
|
7182
7030
|
|
|
7183
|
-
|
|
7184
|
-
Dev Note: Story Requires the following tests:
|
|
7185
|
-
|
|
7186
|
-
- [ ] {{type f.e. Jest}} Unit Tests: (nextToFile: {{true|false}}), coverage requirement: {{from strategy or default 80%}}
|
|
7187
|
-
- [ ] {{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`}}
|
|
7188
|
-
- [ ] {{type f.e. Cypress}} E2E: location: {{f.e. `/e2e/{epic-name/bar.test.ts`}}
|
|
7031
|
+
## Change Log
|
|
7189
7032
|
|
|
7190
|
-
|
|
7191
|
-
|
|
7192
|
-
{{ f.e. `- dev will create a script with task 3 above that you can run with "npm run test-initiate-launch-sequence" and validate Armageddon is initiated`}}
|
|
7033
|
+
| Date | Version | Description | Author |
|
|
7034
|
+
| :--- | :------ | :---------- | :----- |
|
|
7193
7035
|
|
|
7194
7036
|
## Dev Agent Record
|
|
7195
7037
|
|
|
@@ -7197,29 +7039,11 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
|
|
7197
7039
|
|
|
7198
7040
|
### Debug Log References
|
|
7199
7041
|
|
|
7200
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update]]
|
|
7201
|
-
[[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]]
|
|
7202
|
-
|
|
7203
7042
|
### Completion Notes List
|
|
7204
7043
|
|
|
7205
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
|
7206
|
-
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
|
7207
|
-
|
|
7208
7044
|
### File List
|
|
7209
7045
|
|
|
7210
|
-
[[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
|
|
7211
|
-
|
|
7212
|
-
### Change Log
|
|
7213
|
-
|
|
7214
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
|
7215
|
-
[[LLM: (Dev Agent) Track document versions and changes during development that deviate from story dev start]]
|
|
7216
|
-
|
|
7217
|
-
| Date | Version | Description | Author |
|
|
7218
|
-
| :--- | :------ | :---------- | :----- |
|
|
7219
|
-
|
|
7220
7046
|
## QA Results
|
|
7221
|
-
|
|
7222
|
-
[[LLM: QA Agent Results]]
|
|
7223
7047
|
==================== END: templates#story-tmpl ====================
|
|
7224
7048
|
|
|
7225
7049
|
==================== START: checklists#architect-checklist ====================
|
|
@@ -8921,7 +8745,7 @@ Generate a concise validation report:
|
|
|
8921
8745
|
- What questions would you have?
|
|
8922
8746
|
- What might cause delays or rework?
|
|
8923
8747
|
|
|
8924
|
-
Be pragmatic - perfect documentation doesn't exist
|
|
8748
|
+
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.]]
|
|
8925
8749
|
|
|
8926
8750
|
| Category | Status | Issues |
|
|
8927
8751
|
| ------------------------------------ | ------ | ------ |
|