docs-standards

You can standardize markdown documentation by applying the Microsoft Style Guide and squad-specific conventions to author, review, and publish pages. This enforces consistent tone, structure, and readability across your documentation ecosystem.

The required YAML frontmatter for squad documentation must include name and description fields. This metadata ensures completeness and search-optimized tagging, improving discoverability across the documentation ecosystem.

You structure a markdown description body using a three-section format with a single-sentence Quick Start instruction. This enforces squad-specific formatting and ensures new pages validate against established documentation patterns.

Yes, you can apply squad-specific formatting conventions for headings, tone, and structure alongside Microsoft style rules. This combination standardizes documentation while maintaining readability and discoverability for your specific team.

The best way to validate new documentation pages is during the review workflow by checking metadata completeness and structural formatting. This ensures new pages conform to the three-section description body and YAML frontmatter standards.

You should enforce search-optimized tagging during the authoring and publishing tasks of markdown documentation. This metadata completeness ensures the documentation is discoverable and aligns with squad-specific formatting standards.