docs-standards

Enforce Microsoft Style Guide rules for documentation structure and formatting.

Updated Nov 27, 2024
One-click install
npx skills add https://github.com/Izak90/Izak90.github.io --skill docs-standards-izak90
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/Izak90/Izak90.github.io/tree/main/isaac_treinos_ar_livre/.copilot/skills/docs-standards
Command: npx skills add https://github.com/Izak90/Izak90.github.io --skill docs-standards-izak90

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Microsoft Style Guide + Squad-specific documentation patterns provide a consistent, readable baseline for all squad documentation.

Core Features & Use Cases

  • Enforces sentence-case headings, active voice, second-person perspective, and present tense.
  • Defines squad-specific formatting patterns to improve scanability and cross-reference linking.
  • Useful for teams adopting standardized documentation practices across projects.

Quick Start

Apply the Microsoft Style Guide and squad conventions to new and existing docs.

Frequently Asked Questions about docs-standards

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

FAQPage Schema
How do I standardize documentation across multiple squads?

You standardize documentation by enforcing a shared style guide and squad-specific formatting patterns. This Skill applies Microsoft Style Guide rules to product guides, API references, and design docs, ensuring consistent structure, voice, and cross-references across teams.

What writing standards does the Microsoft Style Guide enforce for technical docs?

The Microsoft Style Guide enforces sentence-case headings, active voice, second-person perspective, and present tense. These writing standards improve readability and scannability for product guides and API references.

Can I use this to update existing API references and design docs?

Yes, you can apply these documentation standards to both new and existing docs. The Skill enforces formatting and style rules on API references and design docs, aligning them with squad-specific patterns and Microsoft Style Guide conventions.

What's the best way to improve scannability and cross-reference linking in team docs?

To improve scannability, apply squad-specific formatting patterns and style guide rules. This enforces consistent heading case, structure, and cross-reference linking across all project documentation.

Does standardizing docs with this approach require any specific dependencies?

No dependencies are required to standardize docs with this approach. You apply the Microsoft Style Guide and squad conventions directly to your product guides, API references, and design docs without external modules.