docs-standards

Enforces Microsoft Style Guide and Squad formatting conventions in documentation.

2|Updated Jul 24, 2026
One-click install
npx skills add https://github.com/elbruno/ElBruno.MagenticUI --skill docs-standards-elbruno
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/elbruno/ElBruno.MagenticUI/tree/main/.squad/templates/skills/docs-standards
Command: npx skills add https://github.com/elbruno/ElBruno.MagenticUI --skill docs-standards-elbruno

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation written by multiple contributors drifts in tone, heading style, and structure, which hurts readability and breaks automated docs tests. This Skill provides a single reference for Microsoft Style Guide rules plus Squad-specific formatting patterns so every page stays consistent. ## Core Features & Use Cases - Style rule enforcement: Sentence-case headings, active voice, second person, present tense, and no ampersands in prose. - Squad formatting patterns: Scannable structure with short paragraphs, bullet lists, "Try this" prompts at the top, experimental warnings, and cross-references at the bottom. - Test sync rule: Reminds contributors to update EXPECTED_* arrays in test/docs-build.test.ts whenever new docs pages are added. - Use Case: When drafting a new feature page under features/ or scenarios/, apply this Skill to produce correctly styled Markdown and update the docs build test assertions in the same commit. ## Quick Start Review my new documentation page and rewrite it to follow the Microsoft Style Guide and Squad formatting conventions.

Frequently Asked Questions about docs-standards

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write documentation that follows the Microsoft Style Guide?▼

Use sentence-case headings, active voice, second person, and present tense throughout. Avoid ampersands in prose except in code, brand names, or UI elements, and keep paragraphs short for scannability.

What structure should a Squad documentation page follow?▼

Start with an H1 title, add any experimental warning callout, include a Try-this prompt users can copy, then an overview, a horizontal rule, and H2 content sections. Place cross-references to related pages at the bottom.

Why does the docs build test fail after adding a new page?▼

The test file test/docs-build.test.ts contains EXPECTED_* arrays listing pages under features/, scenarios/, and guides/. Adding a page without updating the corresponding array in the same commit causes the assertion to fail.

Should headings use title case or sentence case in technical docs?▼

Sentence case is required: write "Getting started" rather than "Getting Started". Title-casing headings is listed as an anti-pattern under the Microsoft Style Guide rules.

When should I use bullets versus paragraphs in documentation?▼

Use paragraphs of three to four sentences for narrative explanation, bullets for scannable lists, and tables for structured data. Long dense paragraphs are an anti-pattern because they break scannability.