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

@@ -77,6 +77,7 @@ Required commands per schema:
```
Add role-specific commands:
- Use pattern: `^\\*[a-z][a-z0-9-]*( \\{[^}]+\\})?$`
- Include clear descriptions (10+ chars)
- Reference tasks when appropriate
@@ -98,9 +99,10 @@ Analyze where this IDE agent fits in workflows:
- For specialized agents → specific workflow steps
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
@@ -118,9 +120,10 @@ Consider which teams benefit from this IDE agent:
- Domain experts → relevant specialized teams
3. **Document integration**:
```markdown
## Team Integration
Recommended teams for this agent:
- `team-fullstack`: Provides specialized {domain} expertise
- `team-no-ui`: Enhances backend {capability}
@@ -243,7 +246,7 @@ Recommended teams for this agent:
- [ ] Persona has all 5 required fields
- [ ] Minimum 3 Core Principles including Numbered Options Protocol
- [ ] First startup instruction announces name/role with *help
- [ ] Includes *help and *chat-mode commands
- [ ] Includes *help and*chat-mode commands
- [ ] Commands follow pattern requirements
- [ ] Workflow integration documented
- [ ] Team integration suggestions provided
@@ -259,4 +262,4 @@ Recommended teams for this agent:
5. **Integration First**: Consider how agent enhances existing workflows
6. **Schema Compliance**: Always validate against the schema
This schema-driven approach ensures IDE agents are consistent, integrated, and valuable additions to the BMAD ecosystem.
This schema-driven approach ensures IDE agents are consistent, integrated, and valuable additions to the BMAD ecosystem.