docs-standards

Solid

Microsoft Style Guide + Squad-specific documentation patterns

AI & Automation 58 stars 15 forks Updated 2 weeks ago MIT

Install

View on GitHub

Quality Score: 87/100

Stars 20%
59
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

## Context Squad documentation follows the Microsoft Style Guide with Squad-specific conventions. Consistency across docs builds trust and improves discoverability. ## Patterns ### Microsoft Style Guide Rules - **Sentence-case headings:** "Getting started" not "Getting Started" - **Active voice:** "Run the command" not "The command should be run" - **Second person:** "You can configure..." not "Users can configure..." - **Present tense:** "The system routes..." not "The system will route..." - **No ampersands in prose:** "and" not "&" (except in code, brand names, or UI elements) ### Squad Formatting Patterns - **Scannability first:** Paragraphs for narrative (3-4 sentences max), bullets for scannable lists, tables for structured data - **"Try this" prompts at top:** Start feature/scenario pages with practical prompts users can copy - **Experimental warnings:** Features in preview get callout at top - **Cross-references at bottom:** Related pages linked after main content ### Structure - **Title (H1)** → **Warning/callout** → **Try this code** → **Overview** → **HR** → **Content (H2 sections)** ### Test Sync Rule - **Always update test assertions:** When adding docs pages to `features/`, `scenarios/`, `guides/`, update corresponding `EXPECTED_*` arrays in `test/docs-build.test.ts` in the same commit ## Examples ✓ **Correct:** ```markdown # Getting started with Squad > ⚠️ **Experimental:** This feature is in preview. Try this: \`\`\`bash squad init \`\`\` Squad help...

Details

Author
DanWahlin
Repository
DanWahlin/ai-agent-board
Created
6 months ago
Last Updated
2 weeks ago
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category