Patterns and templates for creating comprehensive API documentation using OpenAPI/Swagger, AsyncAPI, and manual documentation approaches. Use this skill whenever the user wants to document REST endpoints, generate or improve an OpenAPI spec, create Swagger docs, document WebSocket/event-driven APIs with AsyncAPI, review API documentation completeness, add request/response examples, document authentication schemes, set up API documentation portals (Swagger UI, ReDoc, Stoplight), or convert between API doc formats. Also applies when discussing endpoint parameters, response codes, schema definitions, pagination patterns, error response formats, or code-first vs design-first API documentation. If the user mentions "API docs", "OpenAPI", "Swagger", "AsyncAPI", "endpoint documentation", "API reference", or "API spec", this skill likely applies.
2026-03-19
Desenvolvedores de software Generate, update, review, and maintain changelogs using Keep a Changelog format, semantic-release, and conventional commits. Use this skill whenever the user wants to add a changelog entry, prepare release notes, document version changes, generate a changelog from git history, configure semantic-release, understand conventional commit mappings, review changelog format, create migration guides for breaking changes, or troubleshoot semantic-release issues. Also applies when discussing version bumps, release automation, CHANGELOG.md formatting, or any task involving documenting what changed between software versions. If the user mentions "changelog", "release notes", "version history", "what changed", "semantic-release", or "conventional commits", this skill likely applies. Also covers "what's new", "upgrade guide", and "release history" queries.
2026-03-19
Classify, create, review, and maintain documentation using the Diátaxis framework — the four-quadrant system (tutorials, how-to guides, reference, explanation) that separates documentation by user need. Use this skill whenever the user wants to classify documentation into quadrants, perform a documentation gap analysis, check for mode mixing, create documentation following a specific quadrant template, organize docs by type, review documentation for Diátaxis alignment, add diataxis_type frontmatter, split mixed-mode documents, or structure new docs as tutorials vs how-to guides vs reference vs explanation. Also applies when discussing documentation taxonomy, learning-oriented vs task-oriented content, quadrant coverage matrices, cross-reference audits between doc types, or when the user is unsure whether something should be a tutorial or a how-to guide. If the user mentions "Diataxis", "documentation types", "tutorials vs guides", "quadrants", "mode purity", "gap analysis", "documentation classification", "do
2026-03-19
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.
2026-03-19
