skills.rest
jguadagno
jguadagnoCOMMUNITY
Explore all skills by this author →
Website𝕏@jguadagnoGitHub

docs-standards

Enforce Microsoft Style Guide rules and squad conventions for technical documentation.

18|3|Updated Jul 3, 2020
Search Tags:#best practices#documentation#formatting#style guide#writing standards
One-click install
npx skills add https://github.com/jguadagno/jjgnet-broadcast --skill docs-standards-jguadagno
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/jguadagno/jjgnet-broadcast/tree/main/.agents/skills/docs-standards
Command: npx skills add https://github.com/jguadagno/jjgnet-broadcast --skill docs-standards-jguadagno

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It addresses the need for standardized, clear, and effective documentation practices that enhance readability and user trust.

Core Features & Use Cases

  • Standardized Style Guide: Enforces Microsoft Style Guide rules for heading formats, voice, and writing tone.
  • Formatting Patterns: Provides best practices for structuring documentation content, including titles, warnings, examples, and cross-references.
  • Quality Control: Guides inclusion of proper testing assertions and avoids anti-patterns, ensuring high-quality documentation standards.

Quick Start

Review the style and formatting rules to update your documentation pages accordingly.

Frequently Asked Questions about docs-standards

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

FAQPage Schema
What are the best practices for technical writing formatting and style?▼

Documentation quality control involves including proper testing assertions and avoiding anti-patterns to maintain high standards. This process ensures prescribed patterns are followed, improving discoverability and trustworthiness for team projects.

How do I establish consistent documentation standards for my team?▼

You establish team documentation standards by applying Microsoft Style Guide rules for heading formats, voice, and tone alongside squad conventions. This enforces prescribed patterns and quality checks, ensuring high-quality, scannable technical writing across team projects.

How do I structure technical documentation for better scannability?▼

You structure technical documentation for scannability by following formatting patterns for titles, warnings, examples, and cross-references. Adhering to these structural style guide rules allows readers to quickly discover and trust the content.

Does this style guide support documentation testing assertions?▼

Yes, the style guide supports documentation testing assertions by guiding their proper inclusion and avoiding anti-patterns. This quality control measure ensures technical writing meets prescribed standards and improves overall trustworthiness.

Related Skills

Explore More Content & Communication Skills→
guilhermemarketingguilhermemarketing
59

docs-writer

Write and refine Markdown documentation to align with the style guide and contribution workflow.

Community
Intermediate
natelandaunatelandau
222

documentation-writer

Generate and refine user-facing documentation for software projects.

Community
Intermediate
georgekhananaevgeorgekhananaev
27

md

Enforce consistent Markdown syntax across documentation and README files.

Community
Basic
ghalacticghalactic

google-developer-style-guide-structure

Enforce Google developer documentation style guide rules on technical writing.

Official
Advanced