skills.rest
usepowershell
usepowershellCOMMUNITY
Explore all skills by this author →
Website𝕏@usepowershellGitHub

docs-standards

Standardize Markdown documentation with Microsoft Style Guide and squad patterns.

9|1|Updated Jul 21, 2025
Search Tags:#documentation#editing#style-guide#technical-writing#test-sync#scannability
One-click install
npx skills add https://github.com/usepowershell/PoshMcp --skill docs-standards-usepowershell
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/usepowershell/PoshMcp/tree/main/.copilot/skills/docs-standards
Command: npx skills add https://github.com/usepowershell/PoshMcp --skill docs-standards-usepowershell

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Squad documentation often varies in tone, structure, and format which reduces discoverability and increases reader friction; this skill provides explicit, team-aligned rules to ensure consistency and trust across docs.

Core Features & Use Cases

  • Microsoft Style Guide alignment: Enforces sentence-case headings, active voice, second person, present tense, and avoidance of ampersands in prose.
  • Squad-specific patterns: Provides scannability-first formatting, "Try this" prompts, experimental warnings, cross-reference placement, and a recommended page structure.
  • Test sync rule: Requires updating corresponding EXPECTED_* arrays when adding documentation pages to keep docs and tests in sync.
  • Use Case: Convert ad-hoc feature or scenario pages into consistent, scannable docs that pass automated style checks and align with squad expectations.

Quick Start

Apply the docs-standards rules to the file getting-started.md and return a revised markdown that uses sentence-case headings, active voice, second person, scannable paragraphs, a Try this prompt, an experimental warning when needed, and notes about updating EXPECTED_* tests.

Frequently Asked Questions about docs-standards

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

FAQPage Schema
How do I standardize markdown documentation style for consistency and scannability?▼

Standardize markdown documentation by applying rules for sentence-case headings, active voice, second person, short paragraphs, and structured page layouts to improve scannability and voice consistency across teams.

What is the Microsoft Style Guide rule for technical writing headings?▼

The Microsoft Style Guide rule for technical writing requires sentence-case headings, present tense, active voice, and second person. It also enforces scannability-first formatting and the avoidance of ampersands in prose.

How do I keep documentation pages and test arrays in sync?▼

Keep documentation pages and tests in sync by updating corresponding EXPECTED_* test arrays whenever new pages are added. This test sync rule ensures documentation changes are validated by automated checks.

How do I make technical writing more scannable for feature and scenario pages?▼

Make technical writing scannable by using short paragraphs, sentence-case headings, Try this prompts, experimental warnings, and structured cross-reference placement to reduce reader friction and improve content discoverability.

Do I need any dependencies to enforce a style guide on markdown files?▼

No dependencies are required to enforce a style guide on markdown files. The rules apply directly to markdown feature, scenario, and guide pages to convert ad-hoc content into standardized documentation.

Why does squad documentation vary in tone and structure across teams?▼

Squad documentation varies in tone and structure due to ad-hoc writing practices. Applying explicit, team-aligned style guide rules ensures consistency, reduces reader friction, and builds trust across distributed teams.

Related Skills

Explore More Content & Communication Skills→
sachinnair90sachinnair90

docs-standards

Standardize Markdown documentation to match Microsoft Style Guide and squad rules.

Community
Basic
mpauloskympaulosky

docs-standards

Validate project documentation against Microsoft Style Guide and Squad patterns.

Community
Basic
Golnaz89Golnaz89

docs-standards

Enforce Microsoft Style Guide rules and squad-specific formatting in documentation.

Community
Intermediate
gagan114662gagan114662

writing-coach

Enhance written content for clarity, style, and structure.

Community
Basic