skills.rest
elbruno
elbrunoCOMMUNITY
Explore all skills by this author →
Website𝕏@elbrunoGitHub

docs-standards

Enforce Microsoft-style writing conventions and Squad documentation structure for technical docs.

2|Updated Apr 21, 2026
Search Tags:#documentation#consistency#technical writing#style guide#cross-references#scannability#docs testing
One-click install
npx skills add https://github.com/elbruno/md-to-slides --skill docs-standards-elbruno
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/elbruno/md-to-slides/tree/main/.copilot/skills/docs-standards
Command: npx skills add https://github.com/elbruno/md-to-slides --skill docs-standards-elbruno

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates inconsistent documentation that frustrates readers and slows collaboration by enforcing a clear Microsoft-style standard plus Squad-specific page patterns.

Core Features & Use Cases

  • Microsoft Style Guide enforcement: sentence-case headings, active voice, second person, present tense, and no ampersands in prose.
  • Squad documentation structure and scannability: predictable page layout with warnings/callouts, “Try this” prompts, and cross-references placed consistently.
  • Quality and release readiness: includes a test sync rule so new docs pages stay aligned with automated documentation build assertions.

Quick Start

Use the docs-standards guidelines when writing or updating Squad documentation pages, then verify any new features/, scenarios/, or guides/ entries update the corresponding EXPECTED_* arrays in test/docs-build.test.ts.

Frequently Asked Questions about docs-standards

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

FAQPage Schema
How do I enforce Microsoft style guide conventions in technical documentation?▼

Enforce Microsoft style guide conventions by applying sentence-case headings, active voice, second-person present tense, and avoiding ampersands in prose. This standardizes technical documentation for readability and consistency across all pages.

What's the best way to structure documentation pages for scannability?▼

Structure documentation pages for scannability using predictable layouts with warnings, callouts, and "Try this" prompts. Place cross-references consistently to help readers navigate features, scenarios, and guides efficiently.

How do I keep automated documentation tests synchronized with new pages?▼

Keep automated documentation tests synchronized by updating the corresponding EXPECTED_* arrays in test/docs-build.test.ts whenever you add new entries to features/, scenarios/, or guides/ directories.

Does writing Microsoft-style technical documentation require any specific dependencies?▼

Writing Microsoft-style technical documentation requires no specific dependencies. The standards apply sentence-case, active voice, and second-person present tense rules directly to your drafting and maintenance workflow.

Why does my documentation build fail after adding new feature or scenario pages?▼

Documentation builds fail when new pages lack synchronized test assertions. Any new features/, scenarios/, or guides/ entries must update the corresponding EXPECTED_* arrays in test/docs-build.test.ts for validation.

When should I use preview-callouts and cross-references in technical writing?▼

Use preview-callouts and cross-references in technical writing when structuring Squad documentation pages. Place them consistently within the page layout to highlight important context and link related features or guides.

Related Skills

Explore More Content & Communication Skills→
GeargrindadminGeargrindadmin

bmad-os-diataxis-style-fix

Correct documentation markdown files to comply with Diataxis and BMad Method style rules.

Community
Intermediate
mpauloskympaulosky

docs-standards

Validate project documentation against Microsoft Style Guide and Squad patterns.

Community
Basic
robpitcherrobpitcher

docs-standards

Enforce Microsoft Style Guide rules and squad formatting patterns in documentation pages.

Community
Intermediate
chdalychdaly

docs-standards

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

Community
Intermediate