docs-standards
Microsoft Style Guide + Squad-specific documentation patterns
Best use case
docs-standards is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Microsoft Style Guide + Squad-specific documentation patterns
Teams using docs-standards should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/docs-standards/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How docs-standards Compares
| Feature / Agent | docs-standards | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Microsoft Style Guide + Squad-specific documentation patterns
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
## 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 helps you build AI teams... --- ## Install Squad Run the following command... ``` ✗ **Incorrect:** ```markdown # Getting Started With Squad // Title case Squad is a tool which will help users... // Third person, future tense You can install Squad with npm & configure it... // Ampersand in prose ``` ## Anti-Patterns - Title-casing headings because "it looks nicer" - Writing in passive voice or third person - Long paragraphs of dense text (breaks scannability) - Adding doc pages without updating test assertions - Using ampersands outside code blocks
Related Skills
My Skill
No description provided.
rework-rate
Measure and interpret PR rework rate — the emerging 5th DORA metric
project-conventions
Core conventions and patterns for this codebase
tiered-memory
Three-tier agent memory model (hot/cold/wiki) for 20-55% context reduction per spawn
test-discipline
Update tests when changing APIs — no exceptions
Skill: Retro Enforcement
## Purpose
reflect
Learning capture system that extracts HIGH/MED/LOW confidence patterns from conversations to prevent repeating mistakes. Use after user corrections ("no", "wrong"), praise ("perfect", "exactly"), or when discovering edge cases. Complements .squad/agents/{agent}/history.md and .squad/decisions.md.
notification-routing
Route agent notifications to specific channels by type — prevent alert fatigue from single-channel flooding
iterative-retrieval
Max-3-cycle protocol for agent sub-tasks with WHY context and coordinator validation. Use when spawning sub-agents to complete scoped work.
error-recovery
Standard recovery patterns for all squad agents. When something fails, adapt — don't just report the failure.
{skill-name}
{what this skill teaches agents}
versioning-policy
Semver versioning rules for Squad SDK and CLI — prevents prerelease version incidents