documentation-style

name	documentation-style
description	Documentation patterns for Markdown formatting, structure, voice/tone, and technical writing best practices. Use for user guides, API docs, code comments, and content reviews.
user-invocable	true
argument-hint	[component or feature to document or review]

Documentation Style & Standards

Provides documentation patterns for Markdown formatting, structure, voice/tone, and technical writing best practices across user guides, API docs, and code comments.

Description

This skill teaches documentation agents how to create clear, consistent, well-structured documentation following industry best practices. It covers Markdown conventions, information architecture, writing style (active voice, concise sentences), code examples, and accessibility considerations for documentation.

When to Use

• Writing user-facing documentation
• Creating API reference guides
• Documenting architecture decisions
• Writing README files
• Creating onboarding materials
• Updating changelogs

When NOT to Use

• Do not use for inline code comments in implementation files — those follow language-specific instructions.
• Do not use for commit messages or PR descriptions — use the git-operations skill instead.

Entry Points

Trigger Phrases: "write documentation", "create user guide", "document this API", "update README", "onboarding guide"