BMAD-METHOD/docs/documentation-standards

BMAD Documentation Standards

Overview

Welcome to the BMAD Documentation Standards repository. This collection of documents establishes the guidelines, processes, and tools used to maintain high-quality documentation across the BMAD Method ecosystem.

Key Documents

Style Guide

Comprehensive guidelines for writing consistent, clear, and professional documentation. Covers formatting, voice, terminology, and structure.

Automated Checks

Details on the automated tools and processes used to validate documentation quality, including linting, spell checking, link validation, and accessibility checks.

Contribution Guidelines

Instructions for contributing to BMAD documentation, including the process for submitting changes, requirements for new content, and best practices.

Review Process

Outlines the multi-stage review workflow for documentation, including technical review, editorial review, and final approval processes.

Getting Started

If you're new to BMAD documentation standards:

1. Start by reading the Style Guide
2. Set up the Automated Checks in your environment
3. Review the Contribution Guidelines before making changes
4. Understand the Review Process your contributions will go through

Implementation

These standards apply to all documentation across the BMAD Method ecosystem:

• Persona documentation
• Setup guides
• Quick-start guides
• Technical references
• API documentation
• Examples and tutorials
• Release notes

Tools and Resources

Documentation Templates

• Persona Documentation Template
• Quick Start Guide Template
• Integration Guide Template

Automation Scripts

• Documentation Linting
• Link Validator
• Accessibility Checker

Visual Assets

• Documentation Icons
• Diagram Templates
• Screenshot Guidelines

Versioning and Updates

These standards follow semantic versioning:

• MAJOR: Significant changes requiring updates to existing documentation
• MINOR: New features or guidelines added in a backward-compatible manner
• PATCH: Clarifications or minor corrections

The current version is 1.0.0.

Feedback and Improvements

We welcome feedback on these documentation standards:

• Open an issue in the BMAD Documentation repository
• Suggest improvements via pull requests
• Discuss in the #documentation channel on Slack

Acknowledgments

These documentation standards were developed with inspiration from:

• Google Developer Documentation Style Guide
• Microsoft Writing Style Guide
• The Ditaxis Framework
• Write the Docs community best practices

---

These documentation standards are maintained by the BMAD Documentation Team. Last updated: Current Date.