docs-standards

Validate project documentation against Microsoft Style Guide and Squad patterns.

Updated Mar 18, 2022
One-click install
npx skills add https://github.com/mpaulosky/dotfiles --skill docs-standards-mpaulosky
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/mpaulosky/dotfiles/tree/main/.copilot/skills/docs-standards
Command: npx skills add https://github.com/mpaulosky/dotfiles --skill docs-standards-mpaulosky

SYSTEM DOCUMENTATION & REQUIREMENTS

## What problem does it solve? Squad documentation must be consistent, scannable, and aligned with the Microsoft Style Guide to reduce review cycles, improve user comprehension, and make docs discoverable across projects. This Skill captures the authoritative rules and team-specific patterns so authors and reviewers apply the same conventions.

## Core Features & Use Cases

  • Style rules: Enforces sentence-case headings, active voice, second-person perspective, present tense, and avoidance of ampersands in prose except where appropriate.
  • Squad patterns: Prioritizes scannability, "Try this" prompts at the top, experimental warnings for preview features, and cross-references placed after main content.
  • Structure & process: Recommends a canonical page layout (Title → Warning → Try this → Overview → HR → H2 sections) and a Test Sync Rule that requires updating EXPECTED_* arrays when adding docs pages.
  • Use cases: Authoring new feature guides, auditing docs for style compliance, and preparing content for release to reduce editorial churn.

### Quick Start Use the docs-standards skill to review a documentation page and return a list of edits and style violations mapped to the Microsoft Style Guide and Squad conventions.

Frequently Asked Questions about docs-standards

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

FAQPage Schema
How do I enforce Microsoft Style Guide rules for technical writing in my documentation?

To enforce Microsoft Style Guide rules for technical writing, apply automated checks that validate sentence-case headings, active voice, second-person perspective, and present tense. This ensures consistent documentation style and reduces editorial review cycles across project guides.

What is the best way to audit documentation for scannability and style compliance?

Auditing documentation for scannability and style compliance involves reviewing pages against established conventions like sentence-case headings, active voice, and the canonical page layout. This process identifies style violations and maps edits to improve user comprehension and discoverability.

How do I structure feature documentation to prioritize scannability and experimental warnings?

To structure feature documentation for scannability, use a canonical page layout: Title, Warning, Try this prompt, Overview, HR, and H2 sections. Place cross-references after the main content and include experimental warnings for preview features.

Why do I need to update test assertion arrays when adding new documentation pages?

Updating test assertion arrays when adding new documentation pages is required by the Test Sync Rule to maintain consistency between documentation and automated tests. This ensures new pages are properly validated and prevents broken cross-references or missing content.

Can I use these documentation style rules for auditing existing feature guides and templates?

Yes, you can use these documentation style rules for auditing existing feature guides, scenarios, and templates. The rules validate headings, voice, tense, scannability, and experimental callouts to ensure all content aligns with team-specific patterns and reduces editorial churn.

What are the limitations of using sentence-case headings and active voice in technical documentation?

Sentence-case headings and active voice are standard technical writing conventions with few limitations, though they require avoiding ampersands in prose except where appropriate. Authors must strictly follow these style rules to maintain consistent formatting across all project documentation.