861 B
861 B
Contributing to BMAD Documentation
This directory contains internal guidelines for maintaining consistent, high-quality documentation across the BMAD Method project.
Style Guides
- Tutorial Style Guide — Formatting standards for tutorials and getting-started guides
Quick Principles
- Clarity over brevity — Be concise, but never at the cost of understanding
- Consistent structure — Follow established patterns so readers know what to expect
- Strategic visuals — Use admonitions, tables, and diagrams purposefully
- Scannable content — Headers, lists, and callouts help readers find what they need
Directory Purpose
This _contributing/ directory is prefixed with underscore to exclude it from the Docusaurus sidebar. These documents are for contributors and maintainers, not end users.