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
2025-06-14 06:33:59 -07:00
committed by GitHub
parent 726c3d35b6
commit 009c77f0f5
35 changed files with 515 additions and 349 deletions

View File

@@ -45,6 +45,7 @@ Based on the schema requirements:
Based on team purpose, recommend agents:
**For Planning & Strategy Teams:**
- `bmad` (required orchestrator)
- `analyst` - Requirements gathering and research
- `pm` - Product strategy and documentation
@@ -52,6 +53,7 @@ Based on team purpose, recommend agents:
- `architect` - Technical planning (if technical planning needed)
**For Design & UX Teams:**
- `bmad` (required orchestrator)
- `ux-expert` - User experience design
- `architect` - Frontend architecture
@@ -59,6 +61,7 @@ Based on team purpose, recommend agents:
- `po` - Design validation
**For Development Teams:**
- `bmad` (required orchestrator)
- `sm` - Sprint coordination
- `dev` - Implementation
@@ -66,6 +69,7 @@ Based on team purpose, recommend agents:
- `architect` - Technical guidance
**For Full-Stack Teams:**
- `bmad` (required orchestrator)
- `analyst` - Initial planning
- `pm` - Product management
@@ -128,7 +132,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 + "*"
@@ -159,8 +163,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:
@@ -182,8 +186,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:
@@ -220,4 +224,4 @@ workflows:
5. **Test Integration**: Verify team works well with selected workflows
6. **Iterate**: Refine team composition based on usage
This schema-driven approach ensures teams are well-structured, purposeful, and integrate seamlessly with the BMAD ecosystem.
This schema-driven approach ensures teams are well-structured, purposeful, and integrate seamlessly with the BMAD ecosystem.