docs-standards

Apply Microsoft Style Guide rules and squad conventions to product documentation.

7|Updated Oct 24, 2020
One-click install
npx skills add https://github.com/snow-jallen/HomeSpeaker --skill docs-standards-snow-jallen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/snow-jallen/HomeSpeaker/tree/main/.copilot/skills/docs-standards
Command: npx skills add https://github.com/snow-jallen/HomeSpeaker --skill docs-standards-snow-jallen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Squad documentation often lacks consistency, clarity, and discoverability. This guidance defines and enforces a common set of formatting, voice, and structural patterns based on the Microsoft Style Guide, ensuring all docs across squads present a uniform experience.

Core Features & Use Cases

  • Microsoft Style Guide Rules: Sentence-case headings, active voice, second person, present tense, and no ampersands in prose.
  • Squad Formatting Patterns: Scannability-first writing, “Try this” prompts at the top, experimental warnings, and cross-references at the bottom.
  • Structure & Quality: Recommended page structure (Title, warning, quick start, overview, sections) to improve readability and maintainability.

Quick Start

Apply these standards to the next documentation page you author.

Frequently Asked Questions about docs-standards

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

FAQPage Schema
How do I standardize squad documentation for consistency across multiple teams?

To standardize squad documentation, apply the Microsoft Style Guide rules for sentence-case headings, active voice, and present tense, while enforcing squad-specific formatting patterns to ensure uniform readability.

What are the Microsoft Style Guide rules for technical writing?

The Microsoft Style Guide rules for technical writing mandate sentence-case headings, active voice, second person, present tense, and no ampersands in prose to ensure clear and consistent documentation.

How do I structure a product documentation page to improve scannability?

Structure product documentation pages using scannability-first writing, placing "Try this" prompts at the top, experimental warnings prominently, and cross-references at the bottom for maintainability.

What is the recommended page structure for API docs and feature guides?

The recommended page structure for API docs and feature guides includes a Title, warning, quick start, overview, and detailed sections, ensuring a uniform and readable experience across squads.

Can I apply these documentation standards to onboarding material?

Yes, you can apply these documentation standards to onboarding material, as the rules for headings, voice, tense, and cross-references are designed for maintaining product documentation across all squad outputs.

Why does my squad's documentation lack consistency and discoverability?

Squad documentation lacks consistency and discoverability when it does not enforce a common set of formatting, voice, and structural patterns like those defined in the Microsoft Style Guide.