docs-standards

Enforces Mintlify and MDX style rules for Vala or Slang projects.

49|6|Updated Aug 24, 2021
One-click install
npx skills add https://github.com/webmaxru/bpm-counter --skill docs-standards-webmaxru
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/webmaxru/bpm-counter/tree/main/.copilot/skills/docs-standards
Command: npx skills add https://github.com/webmaxru/bpm-counter --skill docs-standards-webmaxru

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent documentation across squads undermines trust and discoverability; this standard defines a unified Microsoft Style Guide with squad-specific conventions to ensure clear, scannable docs.

Core Features & Use Cases

  • Microsoft Style Guide Rules: sentence-case headings, active voice, second person, present tense, and no ampersands in prose.
  • Squad Formatting Patterns: scannability-first narratives, top "Try this" prompts, experimental warnings, and cross-references placed at the bottom.
  • Structure & Governance: recommended page layout (title, warning, try this block, overview, sections) and a test-sync rule to keep docs aligned with tests.

Quick Start

Follow these guidelines to author new pages by applying the Microsoft Style Guide with Squad-specific conventions and by including the top "Try this" prompt and bottom cross-reference links.

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 quality across multiple squads?

Standardize documentation quality by enforcing a Microsoft Style Guide with squad-specific conventions for tone, structure, and cross-references. This ensures clear, consistent, and scannable squad pages, guides, and references.

What is the recommended page layout for squad documentation?

The recommended squad documentation layout includes a title, experimental warning, top 'Try this' prompt, overview, and subsequent sections. Cross-reference links must be placed at the bottom to maintain scannability-first narratives.

How do I apply Microsoft Style Guide rules to technical writing?

Apply Microsoft Style Guide rules by using sentence-case headings, active voice, second person, and present tense. Avoid using ampersands in prose to ensure consistent tone and formatting across documentation.

Do I need frontmatter for squad documentation pages?

Frontmatter is required for squad documentation pages and must include both name and description fields. This mandates section formatting and enforces test-sync compliance to keep docs aligned with tests.

What's the best way to keep documentation aligned with tests?

Keep documentation aligned with tests by enforcing a test-sync rule within your standardization process. This governance pattern ensures squad references and guides remain accurate during continuous authoring and editing.