skills.rest
codebytes
codebytesCOMMUNITY
Explore all skills by this author →
Website𝕏@chris_l_ayersGitHub

docs-standards

Applies Microsoft Style Guide and Squad formatting conventions to documentation.

Updated Jun 2, 2026
Search Tags:#documentation#markdown#technical writing#style guide#docs standards#microsoft style guide#writing conventions
One-click install
npx skills add https://github.com/codebytes/btt --skill docs-standards-codebytes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/codebytes/btt/tree/main/.squad/templates/skills/docs-standards
Command: npx skills add https://github.com/codebytes/btt --skill docs-standards-codebytes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation written by multiple contributors drifts in tone, heading style, and structure, making docs harder to scan and maintain. This Skill enforces the Microsoft Style Guide plus Squad-specific conventions so every page follows the same rules. ## Core Features & Use Cases - Style enforcement: Applies sentence-case headings, active voice, second person, present tense, and bans ampersands in prose. - Structural templates: Defines the standard page layout of title, warning callout, try-this prompt, overview, and H2 sections with cross-references at the bottom. - Test sync rule: Reminds authors to update EXPECTED_* arrays in test/docs-build.test.ts whenever new doc pages are added. - Use Case: When drafting a new feature guide, use this Skill to format the page correctly and avoid review rejections for style violations. ## Quick Start Review my new documentation page and rewrite it to follow the Squad docs standards.

Frequently Asked Questions about docs-standards

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

FAQPage Schema
How do I format documentation headings in Microsoft Style Guide?▼

Use sentence-case headings such as "Getting started" rather than title case. Only the first word and proper nouns are capitalized, which keeps headings consistent and easier to scan.

What writing style should technical documentation use?▼

Use active voice, second person, and present tense: "Run the command" instead of "The command should be run" or "Users can configure". Avoid ampersands in prose outside code, brand names, or UI elements.

What structure should a Squad documentation page follow?▼

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

Why do docs tests fail after adding a new page?▼

Adding pages to features, scenarios, or guides directories without updating the EXPECTED_* arrays in test/docs-build.test.ts causes test failures. Update the corresponding assertions in the same commit as the new page.

When should I use paragraphs versus bullet lists in docs?▼

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

Related Skills

Explore More Content & Communication Skills→
ahandselahandsel
1

link-polisher

Rewrite raw Figma and GitHub URLs in Markdown files into descriptive links.

Community
Intermediate
dotnetdotnet
209

docs-standards

Enforce Microsoft-aligned documentation structure and test sync for Squad markdown.

Official
Basic
qtqt
19

skill-linking-check

Detect and fix broken documentation links in QDoc references.

Official
Intermediate
ghalacticghalactic

google-developer-style-guide-formatting

Enforce Google developer documentation style guide formatting with Vale.

Official
Intermediate