refactor: standardize formatting and improve readability across core documents (#211)
### CHANGES - Add newlines and spacing for improved readability - Standardize instructional text for consistency - Renumber lists within tasks for better clarity - Add language identifiers to various code blocks - Update placeholder text for improved consistency - Adjust descriptions and wording in multiple files - Update VS Code settings and dictionary words
This commit is contained in:
Kayvan Sylvan
@@ -7,9 +7,10 @@ You are now operating as a specialized AI agent from the BMAD-METHOD framework.
|
||||
1. **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
|
||||
|
||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||
- `==================== START: folder#filename ====================`
|
||||
- `==================== END: folder#filename ====================`
|
||||
|
||||
|
||||
- `==================== START: folder#filename ====================`
|
||||
- `==================== END: folder#filename ====================`
|
||||
|
||||
When you need to reference a resource mentioned in your instructions:
|
||||
- Look for the corresponding START/END tags
|
||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
||||
@@ -502,7 +503,7 @@ Analyze where this IDE agent fits in workflows:
|
||||
4. **Document recommendations**:
|
||||
```markdown
|
||||
## Workflow Integration
|
||||
|
||||
|
||||
This agent enhances the following workflows:
|
||||
- `greenfield-service`: API design phase (between architecture and implementation)
|
||||
- `brownfield-service`: API refactoring and modernization
|
||||
@@ -522,7 +523,7 @@ Consider which teams benefit from this IDE agent:
|
||||
3. **Document integration**:
|
||||
```markdown
|
||||
## Team Integration
|
||||
|
||||
|
||||
Recommended teams for this agent:
|
||||
- `team-fullstack`: Provides specialized {domain} expertise
|
||||
- `team-no-ui`: Enhances backend {capability}
|
||||
@@ -795,7 +796,7 @@ workflows:
|
||||
Before finalizing, verify:
|
||||
|
||||
1. **Role Coverage**: Does the team have all necessary skills for its workflows?
|
||||
2. **Size Optimization**:
|
||||
2. **Size Optimization**:
|
||||
- Minimum: 2 agents (bmad + 1)
|
||||
- Recommended: 3-7 agents
|
||||
- Maximum with wildcard: bmad + "*"
|
||||
@@ -826,8 +827,8 @@ Document how this team integrates with existing system:
|
||||
bundle:
|
||||
name: "Team API"
|
||||
description: >-
|
||||
Specialized team for API and backend service development. Focuses on
|
||||
robust service architecture, implementation, and testing without UI
|
||||
Specialized team for API and backend service development. Focuses on
|
||||
robust service architecture, implementation, and testing without UI
|
||||
components. Ideal for microservices, REST APIs, and backend systems.
|
||||
|
||||
agents:
|
||||
@@ -849,8 +850,8 @@ workflows:
|
||||
bundle:
|
||||
name: "Team Prototype"
|
||||
description: >-
|
||||
Agile team for rapid prototyping and proof of concept development.
|
||||
Combines planning, design, and implementation for quick iterations
|
||||
Agile team for rapid prototyping and proof of concept development.
|
||||
Combines planning, design, and implementation for quick iterations
|
||||
on new ideas and experimental features.
|
||||
|
||||
agents:
|
||||
@@ -1849,13 +1850,13 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
|
||||
|
||||
5. **SCAMPER Method**
|
||||
[[LLM: Guide through each SCAMPER prompt systematically.]]
|
||||
- **S**ubstitute: What can be substituted?
|
||||
- **C**ombine: What can be combined or integrated?
|
||||
- **A**dapt: What can be adapted from elsewhere?
|
||||
- **M**odify/Magnify: What can be emphasized or reduced?
|
||||
- **P**ut to other uses: What else could this be used for?
|
||||
- **E**liminate: What can be removed or simplified?
|
||||
- **R**everse/Rearrange: What can be reversed or reordered?
|
||||
- **S** = Substitute: What can be substituted?
|
||||
- **C** = Combine: What can be combined or integrated?
|
||||
- **A** = Adapt: What can be adapted from elsewhere?
|
||||
- **M** = Modify/Magnify: What can be emphasized or reduced?
|
||||
- **P** = Put to other uses: What else could this be used for?
|
||||
- **E** = Eliminate: What can be removed or simplified?
|
||||
- **R** = Reverse/Rearrange: What can be reversed or reordered?
|
||||
|
||||
6. **Six Thinking Hats**
|
||||
[[LLM: Cycle through different thinking modes, spending focused time in each.]]
|
||||
@@ -2305,7 +2306,7 @@ Present these numbered options to the user:
|
||||
==================== START: templates#project-brief-tmpl ====================
|
||||
# Project Brief: {{Project Name}}
|
||||
|
||||
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
||||
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
||||
|
||||
Start by asking the user which mode they prefer:
|
||||
1. **Interactive Mode** - Work through each section collaboratively
|
||||
@@ -2464,7 +2465,7 @@ Before beginning, understand what inputs are available (brainstorming results, m
|
||||
### A. Research Summary
|
||||
{{If applicable, summarize key findings from:
|
||||
- Market research
|
||||
- Competitive analysis
|
||||
- Competitive analysis
|
||||
- User interviews
|
||||
- Technical feasibility studies}}
|
||||
|
||||
@@ -2776,7 +2777,7 @@ These replace the standard elicitation options when working on market research d
|
||||
|
||||
{{Create a 2x2 matrix:
|
||||
- Priority 1 (Core Competitors): High Market Share + High Threat
|
||||
- Priority 2 (Emerging Threats): Low Market Share + High Threat
|
||||
- Priority 2 (Emerging Threats): Low Market Share + High Threat
|
||||
- Priority 3 (Established Players): High Market Share + Low Threat
|
||||
- Priority 4 (Monitor Only): Low Market Share + Low Threat}}
|
||||
|
||||
@@ -3277,8 +3278,8 @@ Create a single focused story following this structure:
|
||||
|
||||
#### User Story
|
||||
|
||||
As a {{user type}},
|
||||
I want {{specific action/capability}},
|
||||
As a {{user type}},
|
||||
I want {{specific action/capability}},
|
||||
So that {{clear benefit/value}}.
|
||||
|
||||
#### Story Context
|
||||
@@ -8099,7 +8100,7 @@ Generate a comprehensive validation report that adapts to project type:
|
||||
After presenting the report, ask if the user wants:
|
||||
|
||||
- Detailed analysis of any failed sections
|
||||
- Specific story resequencing suggestions
|
||||
- Specific story reordering suggestions
|
||||
- Risk mitigation strategies
|
||||
- [BROWNFIELD] Integration risk deep-dive]]
|
||||
|
||||
@@ -8218,7 +8219,7 @@ workflow:
|
||||
A[Start: Service Development] --> B{Service Complexity?}
|
||||
B -->|Complex/Production| C[analyst: project-brief.md]
|
||||
B -->|Simple/Prototype| D[analyst: focused project-brief.md]
|
||||
|
||||
|
||||
C --> E[pm: prd.md]
|
||||
E --> F[architect: architecture.md]
|
||||
F --> G{Architecture suggests PRD changes?}
|
||||
@@ -8229,15 +8230,15 @@ workflow:
|
||||
J -->|Yes| K[Return to relevant agent for fixes]
|
||||
J -->|No| L[Move to IDE Environment]
|
||||
K --> I
|
||||
|
||||
|
||||
D --> M[pm: simple epic or story]
|
||||
M --> N[Move to IDE Environment]
|
||||
|
||||
|
||||
C -.-> C1[Optional: brainstorming]
|
||||
C -.-> C2[Optional: market research]
|
||||
F -.-> F1[Optional: technical research]
|
||||
D -.-> D1[Optional: brainstorming]
|
||||
|
||||
|
||||
style L fill:#90EE90
|
||||
style N fill:#90EE90
|
||||
style C fill:#FFE4B5
|
||||
@@ -8353,7 +8354,7 @@ workflow:
|
||||
A[Start: Service Enhancement] --> B{Enhancement Complexity?}
|
||||
B -->|Complex/Significant| C[analyst: analyze existing service]
|
||||
B -->|Simple| D{1 Story or 2-3 Stories?}
|
||||
|
||||
|
||||
C --> E[pm: brownfield-prd.md]
|
||||
E --> F[architect: brownfield-architecture.md]
|
||||
F --> G[po: validate with po-master-checklist]
|
||||
@@ -8361,12 +8362,12 @@ workflow:
|
||||
H -->|Yes| I[Return to relevant agent for fixes]
|
||||
H -->|No| J[Move to IDE Environment]
|
||||
I --> G
|
||||
|
||||
|
||||
D -->|1 Story| K[pm/po/sm: brownfield-create-story]
|
||||
D -->|2-3 Stories| L[pm/po/sm: brownfield-create-epic]
|
||||
K --> M[Move to IDE Environment]
|
||||
L --> M
|
||||
|
||||
|
||||
style J fill:#90EE90
|
||||
style M fill:#90EE90
|
||||
style E fill:#FFE4B5
|
||||
|
||||
Reference in New Issue
Block a user