docs-standards

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

Updated Apr 3, 2026
One-click install
npx skills add https://github.com/sachinnair90/gitgloss --skill docs-standards-sachinnair90
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/sachinnair90/gitgloss/tree/main/.copilot/skills/docs-standards
Command: npx skills add https://github.com/sachinnair90/gitgloss --skill docs-standards-sachinnair90

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you write documentation that is consistent, discoverable, and aligned with the Microsoft Style Guide plus squad-specific conventions, reducing review churn and improving reader trust.

Core Features & Use Cases

  • Style enforcement: Uses sentence-case headings, active voice, second person, present tense, and plain prose conventions to keep docs uniform.
  • Structure guidance: Encourages scannable layouts with short paragraphs, bullets, tables, experimental warnings, and cross-references placed at the end.
  • Documentation workflows: Supports feature pages, scenario pages, and guides that need a predictable structure and test alignment.
  • Example use case: You can use it to rewrite a draft feature page so the title, callouts, examples, and related links match the team’s publishing standards.

Quick Start

Ask the docs-standards skill to review your markdown and rewrite it so it follows the squad’s documentation rules.

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 to follow the Microsoft Style Guide?

To standardize markdown documentation, you can apply Microsoft Style Guide rules to enforce sentence-case headings, active voice, second-person present tense, and scannable layouts. This ensures feature pages and guides match squad-specific publishing conventions.

What is the best way to format technical writing for feature pages and guides?

The best way to format technical writing is to use scannable layouts with short paragraphs, bullets, tables, experimental callouts, and bottom cross-references. This structure creates predictable documentation workflows and improves reader discoverability.

How do I rewrite a draft feature page to match team documentation standards?

You rewrite a draft feature page by enforcing team documentation standards across the title, callouts, examples, and related links. This aligns the content with squad-specific structure and reduces review churn.

Does this approach to documentation formatting enforce specific prose rules?

Yes, documentation formatting enforces specific prose rules by requiring active voice, second-person present tense, and plain prose without ampersands. This creates uniform content across all squad docs and scenario pages.

Can I synchronize test assertions with my scenario pages using content standards?

Yes, you can synchronize test assertions with scenario pages by applying documentation content standards. This ensures that your technical writing maintains predictable structure and alignment with testing workflows.