docs-standards

Apply Microsoft Style Guide conventions to squad documentation workflows and pages.

413|64|Updated Feb 7, 2023

Search Tags:#documentation #consistency #style-guide #cross-references #documentation-patterns #scannability

Ready to run

npx skills add https://github.com/christianhelle/refitter --skill docs-standards-christianhelle

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/christianhelle/refitter/tree/main/.copilot/skills/docs-standards
Command: npx skills add https://github.com/christianhelle/refitter --skill docs-standards-christianhelle

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Squad documentation often lacks consistency and scannability; this skill codifies a Microsoft Style Guide + squad-specific conventions to ensure uniform, readable docs.

Core Features & Use Cases

Enforces consistent headings, tone, and structure across documentation.
Provides squad-focused formatting patterns (scannability, cross-references, warnings for experimental features).
Guides adoption and auditing of docs to improve publish quality and maintainability.

Quick Start

Review existing documentation and apply the documented patterns to draft new pages.

Frequently Asked Questions about docs-standards

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

FAQPage Schema

How do I enforce style guide consistency across squad documentation?▼

Enforce style guide consistency by applying a Microsoft Style Guide with squad-specific conventions, standardizing headings, tone, and structure across documentation workflows to ensure uniform readability.

What's the best way to improve scannability and cross-references in team guides?▼

Improve scannability and cross-references by applying formatting patterns that enforce consistent headings, bolded sections, and specific rules for warnings to guide squad documentation structure and adoption.

How do I structure a documentation page using Microsoft style guidelines?▼

Structure a documentation page by including YAML frontmatter with name and description, followed by three bolded body sections: What problem does it solve, Core Features & Use Cases, and Quick Start.

Does this documentation style guide require specific formatting for experimental features?▼

The documentation style guide requires specific formatting rules for headings, prompts, and patterns, including explicit warnings for experimental features to maintain documentation quality and scannability.

How do I audit existing team documentation for compliance with a style guide?▼

Audit existing team documentation by reviewing pages against documented patterns, checking for required YAML frontmatter, bolded sections, and formatting rules to improve publish quality and maintainability.

When do I need squad-specific conventions in my technical documentation?▼

Squad-specific conventions are needed when team documentation lacks consistency and scannability, requiring standardized formatting rules for structure, tone, cross-references, and experimental feature warnings.