fix: alphabetize agent commands and dependencies for improved organization
- Alphabetized all commands in agent files while maintaining help first and exit last - Alphabetized all dependency categories (checklists, data, tasks, templates, utils, workflows) - Alphabetized items within each dependency category across all 10 core agents: - analyst.md: commands and dependencies reorganized - architect.md: commands and dependencies reorganized - bmad-master.md: commands and dependencies reorganized, fixed YAML parsing issue - bmad-orchestrator.md: commands and dependencies reorganized - dev.md: commands and dependencies reorganized - pm.md: commands and dependencies reorganized - po.md: commands and dependencies reorganized - qa.md: commands and dependencies reorganized - sm.md: commands and dependencies reorganized - ux-expert.md: commands and dependencies reorganized - Fixed YAML parsing error in bmad-master.md by properly quoting activation instructions - Rebuilt all agent bundles and team bundles successfully - Updated expansion pack bundles including new creative writing agents This improves consistency and makes it easier to locate specific commands and dependencies across all agent configurations.
This commit is contained in:
1738
dist/agents/analyst.txt
vendored
1738
dist/agents/analyst.txt
vendored
File diff suppressed because it is too large
Load Diff
1455
dist/agents/architect.txt
vendored
1455
dist/agents/architect.txt
vendored
File diff suppressed because it is too large
Load Diff
1213
dist/agents/bmad-master.txt
vendored
1213
dist/agents/bmad-master.txt
vendored
File diff suppressed because it is too large
Load Diff
27
dist/agents/bmad-orchestrator.txt
vendored
27
dist/agents/bmad-orchestrator.txt
vendored
@@ -53,7 +53,6 @@ activation-instructions:
|
||||
- Assess user goal against available agents and workflows in this bundle
|
||||
- If clear match to an agent's expertise, suggest transformation with *agent command
|
||||
- If project-oriented, suggest *workflow-guidance to explore options
|
||||
- Load resources only when needed - never pre-load
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
@@ -77,21 +76,21 @@ persona:
|
||||
- Always remind users that commands require * prefix
|
||||
commands:
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
task: Run a specific task (list if name not specified)
|
||||
workflow: Start a specific workflow (list if name not specified)
|
||||
workflow-guidance: Get personalized help selecting the right workflow
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
checklist: Execute a checklist (list if name not specified)
|
||||
doc-out: Output full document
|
||||
kb-mode: Load full BMad knowledge base
|
||||
party-mode: Group chat with all agents
|
||||
plan: Create detailed workflow plan before starting
|
||||
plan-status: Show current workflow plan progress
|
||||
plan-update: Update workflow plan status
|
||||
checklist: Execute a checklist (list if name not specified)
|
||||
status: Show current context, active agent, and progress
|
||||
task: Run a specific task (list if name not specified)
|
||||
workflow: Start a specific workflow (list if name not specified)
|
||||
workflow-guidance: Get personalized help selecting the right workflow
|
||||
yolo: Toggle skip confirmations mode
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
exit: Return to BMad or exit session
|
||||
help-display-template: |
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
@@ -160,13 +159,13 @@ workflow-guidance:
|
||||
- Only recommend workflows that actually exist in the current bundle
|
||||
- When *workflow-guidance is called, start an interactive session and list all available workflows with brief descriptions
|
||||
dependencies:
|
||||
data:
|
||||
- bmad-kb.md
|
||||
- elicitation-methods.md
|
||||
tasks:
|
||||
- advanced-elicitation.md
|
||||
- create-doc.md
|
||||
- kb-mode-interaction.md
|
||||
data:
|
||||
- bmad-kb.md
|
||||
- elicitation-methods.md
|
||||
utils:
|
||||
- workflow-management.md
|
||||
```
|
||||
|
||||
165
dist/agents/dev.txt
vendored
165
dist/agents/dev.txt
vendored
@@ -69,9 +69,6 @@ core_principles:
|
||||
- Numbered Options - Always use numbered lists when presenting choices to the user
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- run-tests: Execute linting and tests
|
||||
- explain: teach me what and why you did whatever you just did in detail so I can learn. Explain to me as if you were training a junior engineer.
|
||||
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
|
||||
- develop-story:
|
||||
- order-of-execution: Read (first or next) task→Implement Task and its subtasks→Write tests→Execute validations→Only if ALL pass, then update the task checkbox with [x]→Update story section File List to ensure it lists and new or modified or deleted source file→repeat order-of-execution until complete
|
||||
- story-file-updates-ONLY:
|
||||
@@ -81,15 +78,171 @@ commands:
|
||||
- blocking: 'HALT for: Unapproved deps needed, confirm with user | Ambiguous after story check | 3 failures attempting to implement or fix something repeatedly | Missing config | Failing regression'
|
||||
- ready-for-review: Code matches requirements + All validations pass + Follows standards + File List complete
|
||||
- completion: 'All Tasks and Subtasks marked [x] and have tests→Validations and full regression passes (DON''T BE LAZY, EXECUTE ALL TESTS and CONFIRM)→Ensure File List is Complete→run the task execute-checklist for the checklist story-dod-checklist→set story status: ''Ready for Review''→HALT'
|
||||
- explain: teach me what and why you did whatever you just did in detail so I can learn. Explain to me as if you were training a junior engineer.
|
||||
- review-qa: run task `apply-qa-fixes.md'
|
||||
- run-tests: Execute linting and tests
|
||||
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- execute-checklist.md
|
||||
- validate-next-story.md
|
||||
checklists:
|
||||
- story-dod-checklist.md
|
||||
tasks:
|
||||
- apply-qa-fixes.md
|
||||
- execute-checklist.md
|
||||
- validate-next-story.md
|
||||
```
|
||||
==================== END: .bmad-core/agents/dev.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/apply-qa-fixes.md ====================
|
||||
# apply-qa-fixes
|
||||
|
||||
Implement fixes based on QA results (gate and assessments) for a specific story. This task is for the Dev agent to systematically consume QA outputs and apply code/test changes while only updating allowed sections in the story file.
|
||||
|
||||
## Purpose
|
||||
|
||||
- Read QA outputs for a story (gate YAML + assessment markdowns)
|
||||
- Create a prioritized, deterministic fix plan
|
||||
- Apply code and test changes to close gaps and address issues
|
||||
- Update only the allowed story sections for the Dev agent
|
||||
|
||||
## Inputs
|
||||
|
||||
```yaml
|
||||
required:
|
||||
- story_id: '{epic}.{story}' # e.g., "2.2"
|
||||
- qa_root: from `bmad-core/core-config.yaml` key `qa.qaLocation` (e.g., `docs/project/qa`)
|
||||
- story_root: from `bmad-core/core-config.yaml` key `devStoryLocation` (e.g., `docs/project/stories`)
|
||||
|
||||
optional:
|
||||
- story_title: '{title}' # derive from story H1 if missing
|
||||
- story_slug: '{slug}' # derive from title (lowercase, hyphenated) if missing
|
||||
```
|
||||
|
||||
## QA Sources to Read
|
||||
|
||||
- Gate (YAML): `{qa_root}/gates/{epic}.{story}-*.yml`
|
||||
- If multiple, use the most recent by modified time
|
||||
- Assessments (Markdown):
|
||||
- Test Design: `{qa_root}/assessments/{epic}.{story}-test-design-*.md`
|
||||
- Traceability: `{qa_root}/assessments/{epic}.{story}-trace-*.md`
|
||||
- Risk Profile: `{qa_root}/assessments/{epic}.{story}-risk-*.md`
|
||||
- NFR Assessment: `{qa_root}/assessments/{epic}.{story}-nfr-*.md`
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Repository builds and tests run locally (Deno 2)
|
||||
- Lint and test commands available:
|
||||
- `deno lint`
|
||||
- `deno test -A`
|
||||
|
||||
## Process (Do not skip steps)
|
||||
|
||||
### 0) Load Core Config & Locate Story
|
||||
|
||||
- Read `bmad-core/core-config.yaml` and resolve `qa_root` and `story_root`
|
||||
- Locate story file in `{story_root}/{epic}.{story}.*.md`
|
||||
- HALT if missing and ask for correct story id/path
|
||||
|
||||
### 1) Collect QA Findings
|
||||
|
||||
- Parse the latest gate YAML:
|
||||
- `gate` (PASS|CONCERNS|FAIL|WAIVED)
|
||||
- `top_issues[]` with `id`, `severity`, `finding`, `suggested_action`
|
||||
- `nfr_validation.*.status` and notes
|
||||
- `trace` coverage summary/gaps
|
||||
- `test_design.coverage_gaps[]`
|
||||
- `risk_summary.recommendations.must_fix[]` (if present)
|
||||
- Read any present assessment markdowns and extract explicit gaps/recommendations
|
||||
|
||||
### 2) Build Deterministic Fix Plan (Priority Order)
|
||||
|
||||
Apply in order, highest priority first:
|
||||
|
||||
1. High severity items in `top_issues` (security/perf/reliability/maintainability)
|
||||
2. NFR statuses: all FAIL must be fixed → then CONCERNS
|
||||
3. Test Design `coverage_gaps` (prioritize P0 scenarios if specified)
|
||||
4. Trace uncovered requirements (AC-level)
|
||||
5. Risk `must_fix` recommendations
|
||||
6. Medium severity issues, then low
|
||||
|
||||
Guidance:
|
||||
|
||||
- Prefer tests closing coverage gaps before/with code changes
|
||||
- Keep changes minimal and targeted; follow project architecture and TS/Deno rules
|
||||
|
||||
### 3) Apply Changes
|
||||
|
||||
- Implement code fixes per plan
|
||||
- Add missing tests to close coverage gaps (unit first; integration where required by AC)
|
||||
- Keep imports centralized via `deps.ts` (see `docs/project/typescript-rules.md`)
|
||||
- Follow DI boundaries in `src/core/di.ts` and existing patterns
|
||||
|
||||
### 4) Validate
|
||||
|
||||
- Run `deno lint` and fix issues
|
||||
- Run `deno test -A` until all tests pass
|
||||
- Iterate until clean
|
||||
|
||||
### 5) Update Story (Allowed Sections ONLY)
|
||||
|
||||
CRITICAL: Dev agent is ONLY authorized to update these sections of the story file. Do not modify any other sections (e.g., QA Results, Story, Acceptance Criteria, Dev Notes, Testing):
|
||||
|
||||
- Tasks / Subtasks Checkboxes (mark any fix subtask you added as done)
|
||||
- Dev Agent Record →
|
||||
- Agent Model Used (if changed)
|
||||
- Debug Log References (commands/results, e.g., lint/tests)
|
||||
- Completion Notes List (what changed, why, how)
|
||||
- File List (all added/modified/deleted files)
|
||||
- Change Log (new dated entry describing applied fixes)
|
||||
- Status (see Rule below)
|
||||
|
||||
Status Rule:
|
||||
|
||||
- If gate was PASS and all identified gaps are closed → set `Status: Ready for Done`
|
||||
- Otherwise → set `Status: Ready for Review` and notify QA to re-run the review
|
||||
|
||||
### 6) Do NOT Edit Gate Files
|
||||
|
||||
- Dev does not modify gate YAML. If fixes address issues, request QA to re-run `review-story` to update the gate
|
||||
|
||||
## Blocking Conditions
|
||||
|
||||
- Missing `bmad-core/core-config.yaml`
|
||||
- Story file not found for `story_id`
|
||||
- No QA artifacts found (neither gate nor assessments)
|
||||
- HALT and request QA to generate at least a gate file (or proceed only with clear developer-provided fix list)
|
||||
|
||||
## Completion Checklist
|
||||
|
||||
- deno lint: 0 problems
|
||||
- deno test -A: all tests pass
|
||||
- All high severity `top_issues` addressed
|
||||
- NFR FAIL → resolved; CONCERNS minimized or documented
|
||||
- Coverage gaps closed or explicitly documented with rationale
|
||||
- Story updated (allowed sections only) including File List and Change Log
|
||||
- Status set according to Status Rule
|
||||
|
||||
## Example: Story 2.2
|
||||
|
||||
Given gate `docs/project/qa/gates/2.2-*.yml` shows
|
||||
|
||||
- `coverage_gaps`: Back action behavior untested (AC2)
|
||||
- `coverage_gaps`: Centralized dependencies enforcement untested (AC4)
|
||||
|
||||
Fix plan:
|
||||
|
||||
- Add a test ensuring the Toolkit Menu "Back" action returns to Main Menu
|
||||
- Add a static test verifying imports for service/view go through `deps.ts`
|
||||
- Re-run lint/tests and update Dev Agent Record + File List accordingly
|
||||
|
||||
## Key Principles
|
||||
|
||||
- Deterministic, risk-first prioritization
|
||||
- Minimal, maintainable changes
|
||||
- Tests validate behavior and close gaps
|
||||
- Strict adherence to allowed story update areas
|
||||
- Gate ownership remains with QA; Dev signals readiness via Status
|
||||
==================== END: .bmad-core/tasks/apply-qa-fixes.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||
# Checklist Validation Task
|
||||
|
||||
|
||||
1536
dist/agents/pm.txt
vendored
1536
dist/agents/pm.txt
vendored
File diff suppressed because it is too large
Load Diff
532
dist/agents/po.txt
vendored
532
dist/agents/po.txt
vendored
@@ -75,29 +75,102 @@ persona:
|
||||
- Documentation Ecosystem Integrity - Maintain consistency across all documents
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- execute-checklist-po: Run task execute-checklist (checklist po-master-checklist)
|
||||
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
||||
- correct-course: execute the correct-course task
|
||||
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
|
||||
- create-story: Create user story from requirements (task brownfield-create-story)
|
||||
- doc-out: Output full document to current destination file
|
||||
- execute-checklist-po: Run task execute-checklist (checklist po-master-checklist)
|
||||
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
||||
- validate-story-draft {story}: run the task validate-next-story against the provided story file
|
||||
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
||||
- exit: Exit (confirm)
|
||||
dependencies:
|
||||
checklists:
|
||||
- change-checklist.md
|
||||
- po-master-checklist.md
|
||||
tasks:
|
||||
- correct-course.md
|
||||
- execute-checklist.md
|
||||
- shard-doc.md
|
||||
- correct-course.md
|
||||
- validate-next-story.md
|
||||
templates:
|
||||
- story-tmpl.yaml
|
||||
checklists:
|
||||
- po-master-checklist.md
|
||||
- change-checklist.md
|
||||
```
|
||||
==================== END: .bmad-core/agents/po.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||
# Correct Course Task
|
||||
|
||||
## Purpose
|
||||
|
||||
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
|
||||
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
|
||||
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
|
||||
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
|
||||
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
|
||||
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
|
||||
|
||||
## Instructions
|
||||
|
||||
### 1. Initial Setup & Mode Selection
|
||||
|
||||
- **Acknowledge Task & Inputs:**
|
||||
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
|
||||
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
|
||||
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
|
||||
- **Establish Interaction Mode:**
|
||||
- Ask the user their preferred interaction mode for this task:
|
||||
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
|
||||
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
|
||||
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
|
||||
|
||||
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
|
||||
|
||||
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
|
||||
- For each checklist item or logical group of items (depending on interaction mode):
|
||||
- Present the relevant prompt(s) or considerations from the checklist to the user.
|
||||
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
|
||||
- Discuss your findings for each item with the user.
|
||||
- Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
|
||||
- Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
|
||||
|
||||
### 3. Draft Proposed Changes (Iteratively or Batched)
|
||||
|
||||
- Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
|
||||
- Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
|
||||
- **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
|
||||
- Revising user story text, acceptance criteria, or priority.
|
||||
- Adding, removing, reordering, or splitting user stories within epics.
|
||||
- Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
|
||||
- Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
|
||||
- Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
|
||||
- If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
|
||||
- If in "YOLO Mode," compile all drafted edits for presentation in the next step.
|
||||
|
||||
### 4. Generate "Sprint Change Proposal" with Edits
|
||||
|
||||
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
|
||||
- The proposal must clearly present:
|
||||
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
|
||||
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
|
||||
- Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
|
||||
|
||||
### 5. Finalize & Determine Next Steps
|
||||
|
||||
- Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
|
||||
- Provide the finalized "Sprint Change Proposal" document to the user.
|
||||
- **Based on the nature of the approved changes:**
|
||||
- **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
|
||||
- **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
|
||||
|
||||
## Output Deliverables
|
||||
|
||||
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
|
||||
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
|
||||
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
||||
- **Implicit:** An annotated change-checklist (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
||||
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||
# Checklist Validation Task
|
||||
|
||||
@@ -375,79 +448,6 @@ Document sharded successfully:
|
||||
- Ensure the sharding is reversible (could reconstruct the original from shards)
|
||||
==================== END: .bmad-core/tasks/shard-doc.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||
# Correct Course Task
|
||||
|
||||
## Purpose
|
||||
|
||||
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
|
||||
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
|
||||
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
|
||||
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
|
||||
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
|
||||
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
|
||||
|
||||
## Instructions
|
||||
|
||||
### 1. Initial Setup & Mode Selection
|
||||
|
||||
- **Acknowledge Task & Inputs:**
|
||||
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
|
||||
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
|
||||
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
|
||||
- **Establish Interaction Mode:**
|
||||
- Ask the user their preferred interaction mode for this task:
|
||||
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
|
||||
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
|
||||
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
|
||||
|
||||
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
|
||||
|
||||
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
|
||||
- For each checklist item or logical group of items (depending on interaction mode):
|
||||
- Present the relevant prompt(s) or considerations from the checklist to the user.
|
||||
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
|
||||
- Discuss your findings for each item with the user.
|
||||
- Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
|
||||
- Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
|
||||
|
||||
### 3. Draft Proposed Changes (Iteratively or Batched)
|
||||
|
||||
- Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
|
||||
- Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
|
||||
- **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
|
||||
- Revising user story text, acceptance criteria, or priority.
|
||||
- Adding, removing, reordering, or splitting user stories within epics.
|
||||
- Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
|
||||
- Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
|
||||
- Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
|
||||
- If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
|
||||
- If in "YOLO Mode," compile all drafted edits for presentation in the next step.
|
||||
|
||||
### 4. Generate "Sprint Change Proposal" with Edits
|
||||
|
||||
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
|
||||
- The proposal must clearly present:
|
||||
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
|
||||
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
|
||||
- Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
|
||||
|
||||
### 5. Finalize & Determine Next Steps
|
||||
|
||||
- Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
|
||||
- Provide the finalized "Sprint Change Proposal" document to the user.
|
||||
- **Based on the nature of the approved changes:**
|
||||
- **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
|
||||
- **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
|
||||
|
||||
## Output Deliverables
|
||||
|
||||
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
|
||||
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
|
||||
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
||||
- **Implicit:** An annotated change-checklist (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
||||
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/validate-next-story.md ====================
|
||||
# Validate Next Story Task
|
||||
|
||||
@@ -593,7 +593,7 @@ template:
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
|
||||
title: 'Story {{epic_num}}.{{story_num}}: {{story_title_short}}'
|
||||
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
@@ -695,7 +695,7 @@ sections:
|
||||
sections:
|
||||
- id: agent-model
|
||||
title: Agent Model Used
|
||||
template: '{{agent_model_name_version}}'
|
||||
template: "{{agent_model_name_version}}"
|
||||
instruction: Record the specific AI agent model and version used for development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
@@ -725,6 +725,191 @@ sections:
|
||||
editors: [qa-agent]
|
||||
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
|
||||
|
||||
==================== START: .bmad-core/checklists/change-checklist.md ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
[[LLM: INITIALIZATION INSTRUCTIONS - CHANGE NAVIGATION
|
||||
|
||||
Changes during development are inevitable, but how we handle them determines project success or failure.
|
||||
|
||||
Before proceeding, understand:
|
||||
|
||||
1. This checklist is for SIGNIFICANT changes that affect the project direction
|
||||
2. Minor adjustments within a story don't require this process
|
||||
3. The goal is to minimize wasted work while adapting to new realities
|
||||
4. User buy-in is critical - they must understand and approve changes
|
||||
|
||||
Required context:
|
||||
|
||||
- The triggering story or issue
|
||||
- Current project state (completed stories, current epic)
|
||||
- Access to PRD, architecture, and other key documents
|
||||
- Understanding of remaining work planned
|
||||
|
||||
APPROACH:
|
||||
This is an interactive process with the user. Work through each section together, discussing implications and options. The user makes final decisions, but provide expert guidance on technical feasibility and impact.
|
||||
|
||||
REMEMBER: Changes are opportunities to improve, not failures. Handle them professionally and constructively.]]
|
||||
|
||||
---
|
||||
|
||||
## 1. Understand the Trigger & Context
|
||||
|
||||
[[LLM: Start by fully understanding what went wrong and why. Don't jump to solutions yet. Ask probing questions:
|
||||
|
||||
- What exactly happened that triggered this review?
|
||||
- Is this a one-time issue or symptomatic of a larger problem?
|
||||
- Could this have been anticipated earlier?
|
||||
- What assumptions were incorrect?
|
||||
|
||||
Be specific and factual, not blame-oriented.]]
|
||||
|
||||
- [ ] **Identify Triggering Story:** Clearly identify the story (or stories) that revealed the issue.
|
||||
- [ ] **Define the Issue:** Articulate the core problem precisely.
|
||||
- [ ] Is it a technical limitation/dead-end?
|
||||
- [ ] Is it a newly discovered requirement?
|
||||
- [ ] Is it a fundamental misunderstanding of existing requirements?
|
||||
- [ ] Is it a necessary pivot based on feedback or new information?
|
||||
- [ ] Is it a failed/abandoned story needing a new approach?
|
||||
- [ ] **Assess Initial Impact:** Describe the immediate observed consequences (e.g., blocked progress, incorrect functionality, non-viable tech).
|
||||
- [ ] **Gather Evidence:** Note any specific logs, error messages, user feedback, or analysis that supports the issue definition.
|
||||
|
||||
## 2. Epic Impact Assessment
|
||||
|
||||
[[LLM: Changes ripple through the project structure. Systematically evaluate:
|
||||
|
||||
1. Can we salvage the current epic with modifications?
|
||||
2. Do future epics still make sense given this change?
|
||||
3. Are we creating or eliminating dependencies?
|
||||
4. Does the epic sequence need reordering?
|
||||
|
||||
Think about both immediate and downstream effects.]]
|
||||
|
||||
- [ ] **Analyze Current Epic:**
|
||||
- [ ] Can the current epic containing the trigger story still be completed?
|
||||
- [ ] Does the current epic need modification (story changes, additions, removals)?
|
||||
- [ ] Should the current epic be abandoned or fundamentally redefined?
|
||||
- [ ] **Analyze Future Epics:**
|
||||
- [ ] Review all remaining planned epics.
|
||||
- [ ] Does the issue require changes to planned stories in future epics?
|
||||
- [ ] Does the issue invalidate any future epics?
|
||||
- [ ] Does the issue necessitate the creation of entirely new epics?
|
||||
- [ ] Should the order/priority of future epics be changed?
|
||||
- [ ] **Summarize Epic Impact:** Briefly document the overall effect on the project's epic structure and flow.
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
3. Do user flows need rethinking?
|
||||
4. Are technical constraints different than documented?
|
||||
|
||||
Be thorough - missed conflicts cause future problems.]]
|
||||
|
||||
- [ ] **Review PRD:**
|
||||
- [ ] Does the issue conflict with the core goals or requirements stated in the PRD?
|
||||
- [ ] Does the PRD need clarification or updates based on the new understanding?
|
||||
- [ ] **Review Architecture Document:**
|
||||
- [ ] Does the issue conflict with the documented architecture (components, patterns, tech choices)?
|
||||
- [ ] Are specific components/diagrams/sections impacted?
|
||||
- [ ] Does the technology list need updating?
|
||||
- [ ] Do data models or schemas need revision?
|
||||
- [ ] Are external API integrations affected?
|
||||
- [ ] **Review Frontend Spec (if applicable):**
|
||||
- [ ] Does the issue conflict with the FE architecture, component library choice, or UI/UX design?
|
||||
- [ ] Are specific FE components or user flows impacted?
|
||||
- [ ] **Review Other Artifacts (if applicable):**
|
||||
- [ ] Consider impact on deployment scripts, IaC, monitoring setup, etc.
|
||||
- [ ] **Summarize Artifact Impact:** List all artifacts requiring updates and the nature of the changes needed.
|
||||
|
||||
## 4. Path Forward Evaluation
|
||||
|
||||
[[LLM: Present options clearly with pros/cons. For each path:
|
||||
|
||||
1. What's the effort required?
|
||||
2. What work gets thrown away?
|
||||
3. What risks are we taking?
|
||||
4. How does this affect timeline?
|
||||
5. Is this sustainable long-term?
|
||||
|
||||
Be honest about trade-offs. There's rarely a perfect solution.]]
|
||||
|
||||
- [ ] **Option 1: Direct Adjustment / Integration:**
|
||||
- [ ] Can the issue be addressed by modifying/adding future stories within the existing plan?
|
||||
- [ ] Define the scope and nature of these adjustments.
|
||||
- [ ] Assess feasibility, effort, and risks of this path.
|
||||
- [ ] **Option 2: Potential Rollback:**
|
||||
- [ ] Would reverting completed stories significantly simplify addressing the issue?
|
||||
- [ ] Identify specific stories/commits to consider for rollback.
|
||||
- [ ] Assess the effort required for rollback.
|
||||
- [ ] Assess the impact of rollback (lost work, data implications).
|
||||
- [ ] Compare the net benefit/cost vs. Direct Adjustment.
|
||||
- [ ] **Option 3: PRD MVP Review & Potential Re-scoping:**
|
||||
- [ ] Is the original PRD MVP still achievable given the issue and constraints?
|
||||
- [ ] Does the MVP scope need reduction (removing features/epics)?
|
||||
- [ ] Do the core MVP goals need modification?
|
||||
- [ ] Are alternative approaches needed to meet the original MVP intent?
|
||||
- [ ] **Extreme Case:** Does the issue necessitate a fundamental replan or potentially a new PRD V2 (to be handled by PM)?
|
||||
- [ ] **Select Recommended Path:** Based on the evaluation, agree on the most viable path forward.
|
||||
|
||||
## 5. Sprint Change Proposal Components
|
||||
|
||||
[[LLM: The proposal must be actionable and clear. Ensure:
|
||||
|
||||
1. The issue is explained in plain language
|
||||
2. Impacts are quantified where possible
|
||||
3. The recommended path has clear rationale
|
||||
4. Next steps are specific and assigned
|
||||
5. Success criteria for the change are defined
|
||||
|
||||
This proposal guides all subsequent work.]]
|
||||
|
||||
(Ensure all agreed-upon points from previous sections are captured in the proposal)
|
||||
|
||||
- [ ] **Identified Issue Summary:** Clear, concise problem statement.
|
||||
- [ ] **Epic Impact Summary:** How epics are affected.
|
||||
- [ ] **Artifact Adjustment Needs:** List of documents to change.
|
||||
- [ ] **Recommended Path Forward:** Chosen solution with rationale.
|
||||
- [ ] **PRD MVP Impact:** Changes to scope/goals (if any).
|
||||
- [ ] **High-Level Action Plan:** Next steps for stories/updates.
|
||||
- [ ] **Agent Handoff Plan:** Identify roles needed (PM, Arch, Design Arch, PO).
|
||||
|
||||
## 6. Final Review & Handoff
|
||||
|
||||
[[LLM: Changes require coordination. Before concluding:
|
||||
|
||||
1. Is the user fully aligned with the plan?
|
||||
2. Do all stakeholders understand the impacts?
|
||||
3. Are handoffs to other agents clear?
|
||||
4. Is there a rollback plan if the change fails?
|
||||
5. How will we validate the change worked?
|
||||
|
||||
Get explicit approval - implicit agreement causes problems.
|
||||
|
||||
FINAL REPORT:
|
||||
After completing the checklist, provide a concise summary:
|
||||
|
||||
- What changed and why
|
||||
- What we're doing about it
|
||||
- Who needs to do what
|
||||
- When we'll know if it worked
|
||||
|
||||
Keep it action-oriented and forward-looking.]]
|
||||
|
||||
- [ ] **Review Checklist:** Confirm all relevant items were discussed.
|
||||
- [ ] **Review Sprint Change Proposal:** Ensure it accurately reflects the discussion and decisions.
|
||||
- [ ] **User Approval:** Obtain explicit user approval for the proposal.
|
||||
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
|
||||
|
||||
---
|
||||
==================== END: .bmad-core/checklists/change-checklist.md ====================
|
||||
|
||||
==================== START: .bmad-core/checklists/po-master-checklist.md ====================
|
||||
# Product Owner (PO) Master Validation Checklist
|
||||
|
||||
@@ -1159,188 +1344,3 @@ After presenting the report, ask if the user wants:
|
||||
- **CONDITIONAL**: The plan requires specific adjustments before proceeding.
|
||||
- **REJECTED**: The plan requires significant revision to address critical deficiencies.
|
||||
==================== END: .bmad-core/checklists/po-master-checklist.md ====================
|
||||
|
||||
==================== START: .bmad-core/checklists/change-checklist.md ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
[[LLM: INITIALIZATION INSTRUCTIONS - CHANGE NAVIGATION
|
||||
|
||||
Changes during development are inevitable, but how we handle them determines project success or failure.
|
||||
|
||||
Before proceeding, understand:
|
||||
|
||||
1. This checklist is for SIGNIFICANT changes that affect the project direction
|
||||
2. Minor adjustments within a story don't require this process
|
||||
3. The goal is to minimize wasted work while adapting to new realities
|
||||
4. User buy-in is critical - they must understand and approve changes
|
||||
|
||||
Required context:
|
||||
|
||||
- The triggering story or issue
|
||||
- Current project state (completed stories, current epic)
|
||||
- Access to PRD, architecture, and other key documents
|
||||
- Understanding of remaining work planned
|
||||
|
||||
APPROACH:
|
||||
This is an interactive process with the user. Work through each section together, discussing implications and options. The user makes final decisions, but provide expert guidance on technical feasibility and impact.
|
||||
|
||||
REMEMBER: Changes are opportunities to improve, not failures. Handle them professionally and constructively.]]
|
||||
|
||||
---
|
||||
|
||||
## 1. Understand the Trigger & Context
|
||||
|
||||
[[LLM: Start by fully understanding what went wrong and why. Don't jump to solutions yet. Ask probing questions:
|
||||
|
||||
- What exactly happened that triggered this review?
|
||||
- Is this a one-time issue or symptomatic of a larger problem?
|
||||
- Could this have been anticipated earlier?
|
||||
- What assumptions were incorrect?
|
||||
|
||||
Be specific and factual, not blame-oriented.]]
|
||||
|
||||
- [ ] **Identify Triggering Story:** Clearly identify the story (or stories) that revealed the issue.
|
||||
- [ ] **Define the Issue:** Articulate the core problem precisely.
|
||||
- [ ] Is it a technical limitation/dead-end?
|
||||
- [ ] Is it a newly discovered requirement?
|
||||
- [ ] Is it a fundamental misunderstanding of existing requirements?
|
||||
- [ ] Is it a necessary pivot based on feedback or new information?
|
||||
- [ ] Is it a failed/abandoned story needing a new approach?
|
||||
- [ ] **Assess Initial Impact:** Describe the immediate observed consequences (e.g., blocked progress, incorrect functionality, non-viable tech).
|
||||
- [ ] **Gather Evidence:** Note any specific logs, error messages, user feedback, or analysis that supports the issue definition.
|
||||
|
||||
## 2. Epic Impact Assessment
|
||||
|
||||
[[LLM: Changes ripple through the project structure. Systematically evaluate:
|
||||
|
||||
1. Can we salvage the current epic with modifications?
|
||||
2. Do future epics still make sense given this change?
|
||||
3. Are we creating or eliminating dependencies?
|
||||
4. Does the epic sequence need reordering?
|
||||
|
||||
Think about both immediate and downstream effects.]]
|
||||
|
||||
- [ ] **Analyze Current Epic:**
|
||||
- [ ] Can the current epic containing the trigger story still be completed?
|
||||
- [ ] Does the current epic need modification (story changes, additions, removals)?
|
||||
- [ ] Should the current epic be abandoned or fundamentally redefined?
|
||||
- [ ] **Analyze Future Epics:**
|
||||
- [ ] Review all remaining planned epics.
|
||||
- [ ] Does the issue require changes to planned stories in future epics?
|
||||
- [ ] Does the issue invalidate any future epics?
|
||||
- [ ] Does the issue necessitate the creation of entirely new epics?
|
||||
- [ ] Should the order/priority of future epics be changed?
|
||||
- [ ] **Summarize Epic Impact:** Briefly document the overall effect on the project's epic structure and flow.
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
3. Do user flows need rethinking?
|
||||
4. Are technical constraints different than documented?
|
||||
|
||||
Be thorough - missed conflicts cause future problems.]]
|
||||
|
||||
- [ ] **Review PRD:**
|
||||
- [ ] Does the issue conflict with the core goals or requirements stated in the PRD?
|
||||
- [ ] Does the PRD need clarification or updates based on the new understanding?
|
||||
- [ ] **Review Architecture Document:**
|
||||
- [ ] Does the issue conflict with the documented architecture (components, patterns, tech choices)?
|
||||
- [ ] Are specific components/diagrams/sections impacted?
|
||||
- [ ] Does the technology list need updating?
|
||||
- [ ] Do data models or schemas need revision?
|
||||
- [ ] Are external API integrations affected?
|
||||
- [ ] **Review Frontend Spec (if applicable):**
|
||||
- [ ] Does the issue conflict with the FE architecture, component library choice, or UI/UX design?
|
||||
- [ ] Are specific FE components or user flows impacted?
|
||||
- [ ] **Review Other Artifacts (if applicable):**
|
||||
- [ ] Consider impact on deployment scripts, IaC, monitoring setup, etc.
|
||||
- [ ] **Summarize Artifact Impact:** List all artifacts requiring updates and the nature of the changes needed.
|
||||
|
||||
## 4. Path Forward Evaluation
|
||||
|
||||
[[LLM: Present options clearly with pros/cons. For each path:
|
||||
|
||||
1. What's the effort required?
|
||||
2. What work gets thrown away?
|
||||
3. What risks are we taking?
|
||||
4. How does this affect timeline?
|
||||
5. Is this sustainable long-term?
|
||||
|
||||
Be honest about trade-offs. There's rarely a perfect solution.]]
|
||||
|
||||
- [ ] **Option 1: Direct Adjustment / Integration:**
|
||||
- [ ] Can the issue be addressed by modifying/adding future stories within the existing plan?
|
||||
- [ ] Define the scope and nature of these adjustments.
|
||||
- [ ] Assess feasibility, effort, and risks of this path.
|
||||
- [ ] **Option 2: Potential Rollback:**
|
||||
- [ ] Would reverting completed stories significantly simplify addressing the issue?
|
||||
- [ ] Identify specific stories/commits to consider for rollback.
|
||||
- [ ] Assess the effort required for rollback.
|
||||
- [ ] Assess the impact of rollback (lost work, data implications).
|
||||
- [ ] Compare the net benefit/cost vs. Direct Adjustment.
|
||||
- [ ] **Option 3: PRD MVP Review & Potential Re-scoping:**
|
||||
- [ ] Is the original PRD MVP still achievable given the issue and constraints?
|
||||
- [ ] Does the MVP scope need reduction (removing features/epics)?
|
||||
- [ ] Do the core MVP goals need modification?
|
||||
- [ ] Are alternative approaches needed to meet the original MVP intent?
|
||||
- [ ] **Extreme Case:** Does the issue necessitate a fundamental replan or potentially a new PRD V2 (to be handled by PM)?
|
||||
- [ ] **Select Recommended Path:** Based on the evaluation, agree on the most viable path forward.
|
||||
|
||||
## 5. Sprint Change Proposal Components
|
||||
|
||||
[[LLM: The proposal must be actionable and clear. Ensure:
|
||||
|
||||
1. The issue is explained in plain language
|
||||
2. Impacts are quantified where possible
|
||||
3. The recommended path has clear rationale
|
||||
4. Next steps are specific and assigned
|
||||
5. Success criteria for the change are defined
|
||||
|
||||
This proposal guides all subsequent work.]]
|
||||
|
||||
(Ensure all agreed-upon points from previous sections are captured in the proposal)
|
||||
|
||||
- [ ] **Identified Issue Summary:** Clear, concise problem statement.
|
||||
- [ ] **Epic Impact Summary:** How epics are affected.
|
||||
- [ ] **Artifact Adjustment Needs:** List of documents to change.
|
||||
- [ ] **Recommended Path Forward:** Chosen solution with rationale.
|
||||
- [ ] **PRD MVP Impact:** Changes to scope/goals (if any).
|
||||
- [ ] **High-Level Action Plan:** Next steps for stories/updates.
|
||||
- [ ] **Agent Handoff Plan:** Identify roles needed (PM, Arch, Design Arch, PO).
|
||||
|
||||
## 6. Final Review & Handoff
|
||||
|
||||
[[LLM: Changes require coordination. Before concluding:
|
||||
|
||||
1. Is the user fully aligned with the plan?
|
||||
2. Do all stakeholders understand the impacts?
|
||||
3. Are handoffs to other agents clear?
|
||||
4. Is there a rollback plan if the change fails?
|
||||
5. How will we validate the change worked?
|
||||
|
||||
Get explicit approval - implicit agreement causes problems.
|
||||
|
||||
FINAL REPORT:
|
||||
After completing the checklist, provide a concise summary:
|
||||
|
||||
- What changed and why
|
||||
- What we're doing about it
|
||||
- Who needs to do what
|
||||
- When we'll know if it worked
|
||||
|
||||
Keep it action-oriented and forward-looking.]]
|
||||
|
||||
- [ ] **Review Checklist:** Confirm all relevant items were discussed.
|
||||
- [ ] **Review Sprint Change Proposal:** Ensure it accurately reflects the discussion and decisions.
|
||||
- [ ] **User Approval:** Obtain explicit user approval for the proposal.
|
||||
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
|
||||
|
||||
---
|
||||
==================== END: .bmad-core/checklists/change-checklist.md ====================
|
||||
|
||||
2812
dist/agents/qa.txt
vendored
2812
dist/agents/qa.txt
vendored
File diff suppressed because it is too large
Load Diff
164
dist/agents/sm.txt
vendored
164
dist/agents/sm.txt
vendored
@@ -68,22 +68,95 @@ persona:
|
||||
- You are NOT allowed to implement stories or modify code EVER!
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- draft: Execute task create-next-story.md
|
||||
- correct-course: Execute task correct-course.md
|
||||
- draft: Execute task create-next-story.md
|
||||
- story-checklist: Execute task execute-checklist.md with checklist story-draft-checklist.md
|
||||
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-next-story.md
|
||||
- execute-checklist.md
|
||||
- correct-course.md
|
||||
templates:
|
||||
- story-tmpl.yaml
|
||||
checklists:
|
||||
- story-draft-checklist.md
|
||||
tasks:
|
||||
- correct-course.md
|
||||
- create-next-story.md
|
||||
- execute-checklist.md
|
||||
templates:
|
||||
- story-tmpl.yaml
|
||||
```
|
||||
==================== END: .bmad-core/agents/sm.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||
# Correct Course Task
|
||||
|
||||
## Purpose
|
||||
|
||||
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
|
||||
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
|
||||
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
|
||||
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
|
||||
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
|
||||
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
|
||||
|
||||
## Instructions
|
||||
|
||||
### 1. Initial Setup & Mode Selection
|
||||
|
||||
- **Acknowledge Task & Inputs:**
|
||||
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
|
||||
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
|
||||
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
|
||||
- **Establish Interaction Mode:**
|
||||
- Ask the user their preferred interaction mode for this task:
|
||||
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
|
||||
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
|
||||
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
|
||||
|
||||
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
|
||||
|
||||
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
|
||||
- For each checklist item or logical group of items (depending on interaction mode):
|
||||
- Present the relevant prompt(s) or considerations from the checklist to the user.
|
||||
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
|
||||
- Discuss your findings for each item with the user.
|
||||
- Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
|
||||
- Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
|
||||
|
||||
### 3. Draft Proposed Changes (Iteratively or Batched)
|
||||
|
||||
- Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
|
||||
- Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
|
||||
- **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
|
||||
- Revising user story text, acceptance criteria, or priority.
|
||||
- Adding, removing, reordering, or splitting user stories within epics.
|
||||
- Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
|
||||
- Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
|
||||
- Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
|
||||
- If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
|
||||
- If in "YOLO Mode," compile all drafted edits for presentation in the next step.
|
||||
|
||||
### 4. Generate "Sprint Change Proposal" with Edits
|
||||
|
||||
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
|
||||
- The proposal must clearly present:
|
||||
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
|
||||
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
|
||||
- Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
|
||||
|
||||
### 5. Finalize & Determine Next Steps
|
||||
|
||||
- Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
|
||||
- Provide the finalized "Sprint Change Proposal" document to the user.
|
||||
- **Based on the nature of the approved changes:**
|
||||
- **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
|
||||
- **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
|
||||
|
||||
## Output Deliverables
|
||||
|
||||
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
|
||||
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
|
||||
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
||||
- **Implicit:** An annotated change-checklist (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
||||
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/create-next-story.md ====================
|
||||
# Create Next Story Task
|
||||
|
||||
@@ -288,79 +361,6 @@ The LLM will:
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||
# Correct Course Task
|
||||
|
||||
## Purpose
|
||||
|
||||
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
|
||||
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
|
||||
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
|
||||
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
|
||||
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
|
||||
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
|
||||
|
||||
## Instructions
|
||||
|
||||
### 1. Initial Setup & Mode Selection
|
||||
|
||||
- **Acknowledge Task & Inputs:**
|
||||
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
|
||||
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
|
||||
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
|
||||
- **Establish Interaction Mode:**
|
||||
- Ask the user their preferred interaction mode for this task:
|
||||
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
|
||||
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
|
||||
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
|
||||
|
||||
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
|
||||
|
||||
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
|
||||
- For each checklist item or logical group of items (depending on interaction mode):
|
||||
- Present the relevant prompt(s) or considerations from the checklist to the user.
|
||||
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
|
||||
- Discuss your findings for each item with the user.
|
||||
- Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
|
||||
- Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
|
||||
|
||||
### 3. Draft Proposed Changes (Iteratively or Batched)
|
||||
|
||||
- Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
|
||||
- Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
|
||||
- **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
|
||||
- Revising user story text, acceptance criteria, or priority.
|
||||
- Adding, removing, reordering, or splitting user stories within epics.
|
||||
- Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
|
||||
- Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
|
||||
- Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
|
||||
- If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
|
||||
- If in "YOLO Mode," compile all drafted edits for presentation in the next step.
|
||||
|
||||
### 4. Generate "Sprint Change Proposal" with Edits
|
||||
|
||||
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
|
||||
- The proposal must clearly present:
|
||||
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
|
||||
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
|
||||
- Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
|
||||
|
||||
### 5. Finalize & Determine Next Steps
|
||||
|
||||
- Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
|
||||
- Provide the finalized "Sprint Change Proposal" document to the user.
|
||||
- **Based on the nature of the approved changes:**
|
||||
- **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
|
||||
- **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
|
||||
|
||||
## Output Deliverables
|
||||
|
||||
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
|
||||
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
|
||||
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
||||
- **Implicit:** An annotated change-checklist (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
||||
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||
|
||||
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
|
||||
template:
|
||||
id: story-template-v2
|
||||
@@ -369,7 +369,7 @@ template:
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
|
||||
title: 'Story {{epic_num}}.{{story_num}}: {{story_title_short}}'
|
||||
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
@@ -471,7 +471,7 @@ sections:
|
||||
sections:
|
||||
- id: agent-model
|
||||
title: Agent Model Used
|
||||
template: '{{agent_model_name_version}}'
|
||||
template: "{{agent_model_name_version}}"
|
||||
instruction: Record the specific AI agent model and version used for development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
234
dist/agents/ux-expert.txt
vendored
234
dist/agents/ux-expert.txt
vendored
@@ -77,71 +77,17 @@ commands:
|
||||
- generate-ui-prompt: Run task generate-ai-frontend-prompt.md
|
||||
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- generate-ai-frontend-prompt.md
|
||||
- create-doc.md
|
||||
- execute-checklist.md
|
||||
templates:
|
||||
- front-end-spec-tmpl.yaml
|
||||
data:
|
||||
- technical-preferences.md
|
||||
tasks:
|
||||
- create-doc.md
|
||||
- execute-checklist.md
|
||||
- generate-ai-frontend-prompt.md
|
||||
templates:
|
||||
- front-end-spec-tmpl.yaml
|
||||
```
|
||||
==================== END: .bmad-core/agents/ux-expert.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
||||
# Create AI Frontend Prompt Task
|
||||
|
||||
## Purpose
|
||||
|
||||
To generate a masterful, comprehensive, and optimized prompt that can be used with any AI-driven frontend development tool (e.g., Vercel v0, Lovable.ai, or similar) to scaffold or generate significant portions of a frontend application.
|
||||
|
||||
## Inputs
|
||||
|
||||
- Completed UI/UX Specification (`front-end-spec.md`)
|
||||
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
||||
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
||||
|
||||
## Key Activities & Instructions
|
||||
|
||||
### 1. Core Prompting Principles
|
||||
|
||||
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
|
||||
|
||||
- **Be Explicit and Detailed**: The AI cannot read your mind. Provide as much detail and context as possible. Vague requests lead to generic or incorrect outputs.
|
||||
- **Iterate, Don't Expect Perfection**: Generating an entire complex application in one go is rare. The most effective method is to prompt for one component or one section at a time, then build upon the results.
|
||||
- **Provide Context First**: Always start by providing the AI with the necessary context, such as the tech stack, existing code snippets, and overall project goals.
|
||||
- **Mobile-First Approach**: Frame all UI generation requests with a mobile-first design mindset. Describe the mobile layout first, then provide separate instructions for how it should adapt for tablet and desktop.
|
||||
|
||||
### 2. The Structured Prompting Framework
|
||||
|
||||
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
|
||||
|
||||
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
|
||||
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
|
||||
2. **Detailed, Step-by-Step Instructions**: Provide a granular, numbered list of actions the AI should take. Break down complex tasks into smaller, sequential steps. This is the most critical part of the prompt.
|
||||
- _Example: "1. Create a new file named `RegistrationForm.js`. 2. Use React hooks for state management. 3. Add styled input fields for 'Name', 'Email', and 'Password'. 4. For the email field, ensure it is a valid email format. 5. On submission, call the API endpoint defined below."_
|
||||
3. **Code Examples, Data Structures & Constraints**: Include any relevant snippets of existing code, data structures, or API contracts. This gives the AI concrete examples to work with. Crucially, you must also state what _not_ to do.
|
||||
- _Example: "Use this API endpoint: `POST /api/register`. The expected JSON payload is `{ "name": "string", "email": "string", "password": "string" }`. Do NOT include a 'confirm password' field. Use Tailwind CSS for all styling."_
|
||||
4. **Define a Strict Scope**: Explicitly define the boundaries of the task. Tell the AI which files it can modify and, more importantly, which files to leave untouched to prevent unintended changes across the codebase.
|
||||
- _Example: "You should only create the `RegistrationForm.js` component and add it to the `pages/register.js` file. Do NOT alter the `Navbar.js` component or any other existing page or component."_
|
||||
|
||||
### 3. Assembling the Master Prompt
|
||||
|
||||
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
|
||||
|
||||
1. **Gather Foundational Context**:
|
||||
- Start the prompt with a preamble describing the overall project purpose, the full tech stack (e.g., Next.js, TypeScript, Tailwind CSS), and the primary UI component library being used.
|
||||
2. **Describe the Visuals**:
|
||||
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
|
||||
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
|
||||
3. **Build the Prompt using the Structured Framework**:
|
||||
- Follow the four-part framework from Section 2 to build out the core request, whether it's for a single component or a full page.
|
||||
4. **Present and Refine**:
|
||||
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
||||
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
||||
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
||||
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/create-doc.md ====================
|
||||
# Create Document from Template (YAML Driven)
|
||||
|
||||
@@ -335,6 +281,60 @@ The LLM will:
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||
|
||||
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
||||
# Create AI Frontend Prompt Task
|
||||
|
||||
## Purpose
|
||||
|
||||
To generate a masterful, comprehensive, and optimized prompt that can be used with any AI-driven frontend development tool (e.g., Vercel v0, Lovable.ai, or similar) to scaffold or generate significant portions of a frontend application.
|
||||
|
||||
## Inputs
|
||||
|
||||
- Completed UI/UX Specification (`front-end-spec.md`)
|
||||
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
||||
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
||||
|
||||
## Key Activities & Instructions
|
||||
|
||||
### 1. Core Prompting Principles
|
||||
|
||||
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
|
||||
|
||||
- **Be Explicit and Detailed**: The AI cannot read your mind. Provide as much detail and context as possible. Vague requests lead to generic or incorrect outputs.
|
||||
- **Iterate, Don't Expect Perfection**: Generating an entire complex application in one go is rare. The most effective method is to prompt for one component or one section at a time, then build upon the results.
|
||||
- **Provide Context First**: Always start by providing the AI with the necessary context, such as the tech stack, existing code snippets, and overall project goals.
|
||||
- **Mobile-First Approach**: Frame all UI generation requests with a mobile-first design mindset. Describe the mobile layout first, then provide separate instructions for how it should adapt for tablet and desktop.
|
||||
|
||||
### 2. The Structured Prompting Framework
|
||||
|
||||
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
|
||||
|
||||
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
|
||||
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
|
||||
2. **Detailed, Step-by-Step Instructions**: Provide a granular, numbered list of actions the AI should take. Break down complex tasks into smaller, sequential steps. This is the most critical part of the prompt.
|
||||
- _Example: "1. Create a new file named `RegistrationForm.js`. 2. Use React hooks for state management. 3. Add styled input fields for 'Name', 'Email', and 'Password'. 4. For the email field, ensure it is a valid email format. 5. On submission, call the API endpoint defined below."_
|
||||
3. **Code Examples, Data Structures & Constraints**: Include any relevant snippets of existing code, data structures, or API contracts. This gives the AI concrete examples to work with. Crucially, you must also state what _not_ to do.
|
||||
- _Example: "Use this API endpoint: `POST /api/register`. The expected JSON payload is `{ "name": "string", "email": "string", "password": "string" }`. Do NOT include a 'confirm password' field. Use Tailwind CSS for all styling."_
|
||||
4. **Define a Strict Scope**: Explicitly define the boundaries of the task. Tell the AI which files it can modify and, more importantly, which files to leave untouched to prevent unintended changes across the codebase.
|
||||
- _Example: "You should only create the `RegistrationForm.js` component and add it to the `pages/register.js` file. Do NOT alter the `Navbar.js` component or any other existing page or component."_
|
||||
|
||||
### 3. Assembling the Master Prompt
|
||||
|
||||
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
|
||||
|
||||
1. **Gather Foundational Context**:
|
||||
- Start the prompt with a preamble describing the overall project purpose, the full tech stack (e.g., Next.js, TypeScript, Tailwind CSS), and the primary UI component library being used.
|
||||
2. **Describe the Visuals**:
|
||||
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
|
||||
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
|
||||
3. **Build the Prompt using the Structured Framework**:
|
||||
- Follow the four-part framework from Section 2 to build out the core request, whether it's for a single component or a full page.
|
||||
4. **Present and Refine**:
|
||||
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
||||
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
||||
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
||||
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
||||
|
||||
==================== START: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
|
||||
template:
|
||||
id: frontend-spec-template-v2
|
||||
@@ -343,7 +343,7 @@ template:
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/front-end-spec.md
|
||||
title: '{{project_name}} UI/UX Specification'
|
||||
title: "{{project_name}} UI/UX Specification"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
@@ -371,29 +371,29 @@ sections:
|
||||
sections:
|
||||
- id: user-personas
|
||||
title: Target User Personas
|
||||
template: '{{persona_descriptions}}'
|
||||
template: "{{persona_descriptions}}"
|
||||
examples:
|
||||
- '**Power User:** Technical professionals who need advanced features and efficiency'
|
||||
- '**Casual User:** Occasional users who prioritize ease of use and clear guidance'
|
||||
- '**Administrator:** System managers who need control and oversight capabilities'
|
||||
- "**Power User:** Technical professionals who need advanced features and efficiency"
|
||||
- "**Casual User:** Occasional users who prioritize ease of use and clear guidance"
|
||||
- "**Administrator:** System managers who need control and oversight capabilities"
|
||||
- id: usability-goals
|
||||
title: Usability Goals
|
||||
template: '{{usability_goals}}'
|
||||
template: "{{usability_goals}}"
|
||||
examples:
|
||||
- 'Ease of learning: New users can complete core tasks within 5 minutes'
|
||||
- 'Efficiency of use: Power users can complete frequent tasks with minimal clicks'
|
||||
- 'Error prevention: Clear validation and confirmation for destructive actions'
|
||||
- 'Memorability: Infrequent users can return without relearning'
|
||||
- "Ease of learning: New users can complete core tasks within 5 minutes"
|
||||
- "Efficiency of use: Power users can complete frequent tasks with minimal clicks"
|
||||
- "Error prevention: Clear validation and confirmation for destructive actions"
|
||||
- "Memorability: Infrequent users can return without relearning"
|
||||
- id: design-principles
|
||||
title: Design Principles
|
||||
template: '{{design_principles}}'
|
||||
template: "{{design_principles}}"
|
||||
type: numbered-list
|
||||
examples:
|
||||
- '**Clarity over cleverness** - Prioritize clear communication over aesthetic innovation'
|
||||
- "**Clarity over cleverness** - Prioritize clear communication over aesthetic innovation"
|
||||
- "**Progressive disclosure** - Show only what's needed, when it's needed"
|
||||
- '**Consistent patterns** - Use familiar UI patterns throughout the application'
|
||||
- '**Immediate feedback** - Every action should have a clear, immediate response'
|
||||
- '**Accessible by default** - Design for all users from the start'
|
||||
- "**Consistent patterns** - Use familiar UI patterns throughout the application"
|
||||
- "**Immediate feedback** - Every action should have a clear, immediate response"
|
||||
- "**Accessible by default** - Design for all users from the start"
|
||||
- id: changelog
|
||||
title: Change Log
|
||||
type: table
|
||||
@@ -415,7 +415,7 @@ sections:
|
||||
title: Site Map / Screen Inventory
|
||||
type: mermaid
|
||||
mermaid_type: graph
|
||||
template: '{{sitemap_diagram}}'
|
||||
template: "{{sitemap_diagram}}"
|
||||
examples:
|
||||
- |
|
||||
graph TD
|
||||
@@ -455,7 +455,7 @@ sections:
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: flow
|
||||
title: '{{flow_name}}'
|
||||
title: "{{flow_name}}"
|
||||
template: |
|
||||
**User Goal:** {{flow_goal}}
|
||||
|
||||
@@ -467,13 +467,13 @@ sections:
|
||||
title: Flow Diagram
|
||||
type: mermaid
|
||||
mermaid_type: graph
|
||||
template: '{{flow_diagram}}'
|
||||
template: "{{flow_diagram}}"
|
||||
- id: edge-cases
|
||||
title: 'Edge Cases & Error Handling:'
|
||||
title: "Edge Cases & Error Handling:"
|
||||
type: bullet-list
|
||||
template: '- {{edge_case}}'
|
||||
template: "- {{edge_case}}"
|
||||
- id: notes
|
||||
template: '**Notes:** {{flow_notes}}'
|
||||
template: "**Notes:** {{flow_notes}}"
|
||||
|
||||
- id: wireframes-mockups
|
||||
title: Wireframes & Mockups
|
||||
@@ -482,13 +482,13 @@ sections:
|
||||
elicit: true
|
||||
sections:
|
||||
- id: design-files
|
||||
template: '**Primary Design Files:** {{design_tool_link}}'
|
||||
template: "**Primary Design Files:** {{design_tool_link}}"
|
||||
- id: key-screen-layouts
|
||||
title: Key Screen Layouts
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: screen
|
||||
title: '{{screen_name}}'
|
||||
title: "{{screen_name}}"
|
||||
template: |
|
||||
**Purpose:** {{screen_purpose}}
|
||||
|
||||
@@ -508,13 +508,13 @@ sections:
|
||||
elicit: true
|
||||
sections:
|
||||
- id: design-system-approach
|
||||
template: '**Design System Approach:** {{design_system_approach}}'
|
||||
template: "**Design System Approach:** {{design_system_approach}}"
|
||||
- id: core-components
|
||||
title: Core Components
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: component
|
||||
title: '{{component_name}}'
|
||||
title: "{{component_name}}"
|
||||
template: |
|
||||
**Purpose:** {{component_purpose}}
|
||||
|
||||
@@ -531,19 +531,19 @@ sections:
|
||||
sections:
|
||||
- id: visual-identity
|
||||
title: Visual Identity
|
||||
template: '**Brand Guidelines:** {{brand_guidelines_link}}'
|
||||
template: "**Brand Guidelines:** {{brand_guidelines_link}}"
|
||||
- id: color-palette
|
||||
title: Color Palette
|
||||
type: table
|
||||
columns: ['Color Type', 'Hex Code', 'Usage']
|
||||
columns: ["Color Type", "Hex Code", "Usage"]
|
||||
rows:
|
||||
- ['Primary', '{{primary_color}}', '{{primary_usage}}']
|
||||
- ['Secondary', '{{secondary_color}}', '{{secondary_usage}}']
|
||||
- ['Accent', '{{accent_color}}', '{{accent_usage}}']
|
||||
- ['Success', '{{success_color}}', 'Positive feedback, confirmations']
|
||||
- ['Warning', '{{warning_color}}', 'Cautions, important notices']
|
||||
- ['Error', '{{error_color}}', 'Errors, destructive actions']
|
||||
- ['Neutral', '{{neutral_colors}}', 'Text, borders, backgrounds']
|
||||
- ["Primary", "{{primary_color}}", "{{primary_usage}}"]
|
||||
- ["Secondary", "{{secondary_color}}", "{{secondary_usage}}"]
|
||||
- ["Accent", "{{accent_color}}", "{{accent_usage}}"]
|
||||
- ["Success", "{{success_color}}", "Positive feedback, confirmations"]
|
||||
- ["Warning", "{{warning_color}}", "Cautions, important notices"]
|
||||
- ["Error", "{{error_color}}", "Errors, destructive actions"]
|
||||
- ["Neutral", "{{neutral_colors}}", "Text, borders, backgrounds"]
|
||||
- id: typography
|
||||
title: Typography
|
||||
sections:
|
||||
@@ -556,13 +556,13 @@ sections:
|
||||
- id: type-scale
|
||||
title: Type Scale
|
||||
type: table
|
||||
columns: ['Element', 'Size', 'Weight', 'Line Height']
|
||||
columns: ["Element", "Size", "Weight", "Line Height"]
|
||||
rows:
|
||||
- ['H1', '{{h1_size}}', '{{h1_weight}}', '{{h1_line}}']
|
||||
- ['H2', '{{h2_size}}', '{{h2_weight}}', '{{h2_line}}']
|
||||
- ['H3', '{{h3_size}}', '{{h3_weight}}', '{{h3_line}}']
|
||||
- ['Body', '{{body_size}}', '{{body_weight}}', '{{body_line}}']
|
||||
- ['Small', '{{small_size}}', '{{small_weight}}', '{{small_line}}']
|
||||
- ["H1", "{{h1_size}}", "{{h1_weight}}", "{{h1_line}}"]
|
||||
- ["H2", "{{h2_size}}", "{{h2_weight}}", "{{h2_line}}"]
|
||||
- ["H3", "{{h3_size}}", "{{h3_weight}}", "{{h3_line}}"]
|
||||
- ["Body", "{{body_size}}", "{{body_weight}}", "{{body_line}}"]
|
||||
- ["Small", "{{small_size}}", "{{small_weight}}", "{{small_line}}"]
|
||||
- id: iconography
|
||||
title: Iconography
|
||||
template: |
|
||||
@@ -583,7 +583,7 @@ sections:
|
||||
sections:
|
||||
- id: compliance-target
|
||||
title: Compliance Target
|
||||
template: '**Standard:** {{compliance_standard}}'
|
||||
template: "**Standard:** {{compliance_standard}}"
|
||||
- id: key-requirements
|
||||
title: Key Requirements
|
||||
template: |
|
||||
@@ -603,7 +603,7 @@ sections:
|
||||
- Form labels: {{form_requirements}}
|
||||
- id: testing-strategy
|
||||
title: Testing Strategy
|
||||
template: '{{accessibility_testing}}'
|
||||
template: "{{accessibility_testing}}"
|
||||
|
||||
- id: responsiveness
|
||||
title: Responsiveness Strategy
|
||||
@@ -613,12 +613,12 @@ sections:
|
||||
- id: breakpoints
|
||||
title: Breakpoints
|
||||
type: table
|
||||
columns: ['Breakpoint', 'Min Width', 'Max Width', 'Target Devices']
|
||||
columns: ["Breakpoint", "Min Width", "Max Width", "Target Devices"]
|
||||
rows:
|
||||
- ['Mobile', '{{mobile_min}}', '{{mobile_max}}', '{{mobile_devices}}']
|
||||
- ['Tablet', '{{tablet_min}}', '{{tablet_max}}', '{{tablet_devices}}']
|
||||
- ['Desktop', '{{desktop_min}}', '{{desktop_max}}', '{{desktop_devices}}']
|
||||
- ['Wide', '{{wide_min}}', '-', '{{wide_devices}}']
|
||||
- ["Mobile", "{{mobile_min}}", "{{mobile_max}}", "{{mobile_devices}}"]
|
||||
- ["Tablet", "{{tablet_min}}", "{{tablet_max}}", "{{tablet_devices}}"]
|
||||
- ["Desktop", "{{desktop_min}}", "{{desktop_max}}", "{{desktop_devices}}"]
|
||||
- ["Wide", "{{wide_min}}", "-", "{{wide_devices}}"]
|
||||
- id: adaptation-patterns
|
||||
title: Adaptation Patterns
|
||||
template: |
|
||||
@@ -637,11 +637,11 @@ sections:
|
||||
sections:
|
||||
- id: motion-principles
|
||||
title: Motion Principles
|
||||
template: '{{motion_principles}}'
|
||||
template: "{{motion_principles}}"
|
||||
- id: key-animations
|
||||
title: Key Animations
|
||||
repeatable: true
|
||||
template: '- **{{animation_name}}:** {{animation_description}} (Duration: {{duration}}, Easing: {{easing}})'
|
||||
template: "- **{{animation_name}}:** {{animation_description}} (Duration: {{duration}}, Easing: {{easing}})"
|
||||
|
||||
- id: performance
|
||||
title: Performance Considerations
|
||||
@@ -655,7 +655,7 @@ sections:
|
||||
- **Animation FPS:** {{animation_goal}}
|
||||
- id: design-strategies
|
||||
title: Design Strategies
|
||||
template: '{{performance_strategies}}'
|
||||
template: "{{performance_strategies}}"
|
||||
|
||||
- id: next-steps
|
||||
title: Next Steps
|
||||
@@ -670,17 +670,17 @@ sections:
|
||||
- id: immediate-actions
|
||||
title: Immediate Actions
|
||||
type: numbered-list
|
||||
template: '{{action}}'
|
||||
template: "{{action}}"
|
||||
- id: design-handoff-checklist
|
||||
title: Design Handoff Checklist
|
||||
type: checklist
|
||||
items:
|
||||
- 'All user flows documented'
|
||||
- 'Component inventory complete'
|
||||
- 'Accessibility requirements defined'
|
||||
- 'Responsive strategy clear'
|
||||
- 'Brand guidelines incorporated'
|
||||
- 'Performance goals established'
|
||||
- "All user flows documented"
|
||||
- "Component inventory complete"
|
||||
- "Accessibility requirements defined"
|
||||
- "Responsive strategy clear"
|
||||
- "Brand guidelines incorporated"
|
||||
- "Performance goals established"
|
||||
|
||||
- id: checklist-results
|
||||
title: Checklist Results
|
||||
|
||||
Reference in New Issue
Block a user