skills.rest
zircote
zircoteCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-standards

Audit Markdown documentation structure, formatting, links, and accessibility against defined standards.

3|1|Updated Jan 17, 2026
Search Tags:#documentation#markdown#consistency#review#style-guide#site-generators
One-click install
npx skills add https://github.com/zircote/documentation-review --skill documentation-standards-zircote
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/zircote/documentation-review/tree/main/skills/documentation-standards
Command: npx skills add https://github.com/zircote/documentation-review --skill documentation-standards-zircote

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Standards and patterns for creating, reviewing, and improving technical documentation — covering markdown formatting, heading hierarchy, code blocks, links, writing style, accessibility, and language-native doc toolchains (rustdoc, godoc, Sphinx, TypeDoc, Javadoc, DocC, ExDoc). Use this skill whenever the user wants to review documentation quality, audit markdown formatting, fix document structure, improve technical writing, check doc comment coverage, enforce doc standards, write better docs, or asks about documentation best practices. Also triggers for language-specific doc toolchain questions (rustdoc, godoc, pydoc, JSDoc/TSDoc, Javadoc/KDoc, DocC, ExDoc) and site generator integration (MkDocs, Sphinx, Docusaurus, Astro Starlight). If the user mentions "docs", "documentation", "README", "writing style", "doc comments", "markdown", or "technical writing" in a quality or standards context, this skill likely applies.

Core Features & Use Cases

  • Documentation Standards: Establish and enforce writing, formatting, and accessibility guidelines for technical content.
  • Document Structure: Provide canonical layouts for README, API references, tutorials, and reference docs.
  • Markdown Best Practices: Ensure code blocks specify languages, links are descriptive, and lists are well-formed.
  • Review & Quality Checks: Apply a formal review checklist covering clarity, completeness, accuracy, and consistency.
  • Language Toolchains & Generators: Guidance for rustdoc, godoc, Sphinx, TypeDoc, Javadoc, DocC, MkDocs, Sphinx, Docusaurus, and similar site tools.
  • Site-Generator Integration: Align docs with MkDocs, Sphinx, Docusaurus, Astro Starlight conventions.
  • Reference Materials: Link to language-toolchains and style guides for deeper guidance.
  • Accessibility & Writing Style: Promote accessible, reader-focused writing and consistent terminology.

Quick Start

Start by reviewing a project's documentation against the standards in this skill to begin improving structure and quality.

Frequently Asked Questions about documentation-standards

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

FAQPage Schema
How do I enforce consistent markdown formatting and heading hierarchy in technical documentation?▼

Enforce consistent markdown formatting by auditing heading hierarchy, code block language tags, and link integrity against defined documentation standards. This ensures uniform structure and formatting across all Markdown-heavy projects and technical references.

What is the best way to review technical writing quality and terminology consistency?▼

Review technical writing quality by applying a formal checklist covering clarity, completeness, accuracy, and terminology consistency. This process validates document structure and language standards to ensure reader-focused, accessible technical content.

Does this documentation review approach work with site generators like MkDocs, Sphinx, and Docusaurus?▼

Yes, documentation standards align with site generator conventions for MkDocs, Sphinx, Docusaurus, and Astro Starlight. It validates cross-link integrity and content structure to integrate seamlessly with these documentation site tools.

How do I check doc comment coverage for language-specific toolchains like rustdoc and Javadoc?▼

Check doc comment coverage by auditing language-native documentation toolchains including rustdoc, godoc, Sphinx, TypeDoc, Javadoc, DocC, and ExDoc. It validates API references against defined standards to ensure complete coverage.

What are the limitations of enforcing documentation standards across mixed Markdown and API references?▼

Documentation standards enforcement focuses on Markdown content, API docs, and site generators, auditing headings, code blocks, and links. It may not cover highly dynamic or non-Markdown content formats outside these defined documentation scopes.

Can I use this to audit README structure and writing style for accessibility?▼

Yes, you can audit README structure and writing style to enforce accessibility guidelines. It provides canonical layouts for README files and reference docs, promoting accessible, reader-focused writing and consistent terminology.

Related Skills

Explore More Content & Communication Skills→
mrtolkienmrtolkien
5

docs

Enforce Ghost documentation conventions across user-facing docs and CLI help text.

Community
Basic
zenobi-uszenobi-us
68

documentation-engineer

Automate API documentation creation and maintenance with OpenAPI integration.

Official
Advanced
bigeasyfreemanbigeasyfreeman
2

ldd-enforcement

Automate linting and syntax checking before testing in TDD workflows.

Community
Intermediate
coroboroscoroboros
2

fix-grammar

Correct grammar and spelling in Markdown and documentation files.

Official
Intermediate