documentation-content-generator_skill

Overview

This skill generates technical documentation, API docs, user guides, and tutorials with accessibility and SEO optimization. It produces Markdown, MDX, or HTML output following chosen style guides and includes frontmatter metadata for documentation sites. The generator validates inputs, enforces accessibility checks, and provides enhanced API outputs when given an OpenAPI spec.

How this skill works

The skill inspects the provided source (plain text, files, code directories, or OpenAPI specs) and detects the content type or uses the supplied content_type. For standard docs it selects a template, applies content-generation principles, runs accessibility checks, and emits a formatted document with frontmatter. If an OpenAPI 3.0.x/3.1.x spec is provided, it parses endpoints and schemas, validates the spec, and generates expanded API reference sections and multi-language code samples.

When to use it

• A new feature or endpoint needs clear technical documentation
• You have an OpenAPI spec and need developer-focused API reference
• Create user guides, quickstarts, or step-by-step tutorials
• Refresh documentation for clarity, accessibility, and SEO
• Migrate wiki content into structured, standards-compliant docs

Best practices

• Provide a valid source and set content_type to one of: technical-doc, api-doc, user-guide, tutorial
• Use OpenAPI 3.0.x or 3.1.x for enhanced API output and code samples
• Choose a style_guide (write-the-docs, google, microsoft); conflicts resolve to write-the-docs first
• Ensure images include alt text and provide examples in spec for realistic samples
• Sanitize secrets and sensitive data before submission

Example use cases

• Generate a developer-facing API reference from an OpenAPI YAML file with code snippets
• Create a tutorial and quickstart for a new SDK release with step-by-step examples
• Convert a set of how-to notes into an accessible user guide with headings and alt text
• Refresh legacy documentation to meet WCAG 2.2 AA and SEO meta description limits
• Produce Markdown frontmatter and navigation breadcrumbs for a doc site import