# 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](./style-guide.md)
Comprehensive guidelines for writing consistent, clear, and professional documentation. Covers formatting, voice, terminology, and structure.

### [Automated Checks](./automated-checks.md)
Details on the automated tools and processes used to validate documentation quality, including linting, spell checking, link validation, and accessibility checks.

### [Contribution Guidelines](./contribution-guidelines.md)
Instructions for contributing to BMAD documentation, including the process for submitting changes, requirements for new content, and best practices.

### [Review Process](./review-process.md)
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](./style-guide.md)
2. Set up the [Automated Checks](./automated-checks.md) in your environment
3. Review the [Contribution Guidelines](./contribution-guidelines.md) before making changes
4. Understand the [Review Process](./review-process.md) 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](../../templates/persona-documentation-template.md)
- [Quick Start Guide Template](../../templates/quick-start-template.md)
- [Integration Guide Template](../../templates/integration-guide-template.md)

### Automation Scripts
- [Documentation Linting](../../scripts/lint-docs.js)
- [Link Validator](../../scripts/validate-links.js)
- [Accessibility Checker](../../scripts/check-a11y.js)

### Visual Assets
- [Documentation Icons](../../assets/icons/)
- [Diagram Templates](../../assets/diagrams/)
- [Screenshot Guidelines](../../assets/screenshots/README.md)

## 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](https://github.com/bmad-method/documentation/issues)
- 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.*
