skills.rest
Dazlarus
DazlarusCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-automation

Generates API documentation, docstrings, and automated documentation pipelines from code.

Updated Sep 2, 2026
Search Tags:#openapi#jsdoc#docstrings#documentation automation#sphinx#api documentation#mkdocs
One-click install
npx skills add https://github.com/Dazlarus/karl-code --skill documentation-automation-dazlarus
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-automation
Source: https://github.com/Dazlarus/karl-code/tree/main/.agents/skills/documentation-automation
Command: npx skills add https://github.com/Dazlarus/karl-code --skill documentation-automation-dazlarus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping API references and code documentation accurate and up to date is tedious manual work that quickly drifts out of sync with the codebase. This Skill automates the generation of OpenAPI specs, docstrings, and documentation pipelines so docs stay aligned with the code they describe. ## Core Features & Use Cases - OpenAPI Specification Authoring: Define REST API contracts with paths, schemas, request bodies, and responses in OpenAPI 3.0 YAML. - Docstring Standards: Write Sphinx-style Python docstrings and JSDoc annotations for TypeScript/JavaScript with typed parameters, return values, and raised errors. - Automated Doc Pipelines: Configure MkDocs with mkdocstrings to generate and publish reference documentation directly from source code. - Use Case: After building a FastAPI or Express service, use this Skill to produce an OpenAPI spec, annotate public functions with docstrings, and wire up an MkDocs site that regenerates API docs on every release. ## Quick Start Generate an OpenAPI specification and Sphinx-style docstrings for the user management module in this repository.

Frequently Asked Questions about documentation-automation

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

FAQPage Schema
How do I generate API documentation from code automatically?▼

Define an OpenAPI 3.0 specification describing your paths, schemas, and responses, then use tools like mkdocstrings with MkDocs to render reference docs directly from source code docstrings. This keeps documentation synchronized with the implementation.

How to write Python docstrings for Sphinx documentation?▼

Write docstrings with Args, Returns, Raises, and Example sections following the Sphinx or Google style. Include type annotations in the signature and document each parameter, return value, and raised exception so Sphinx can render structured API pages.

What is the difference between OpenAPI and JSDoc documentation?▼

OpenAPI defines machine-readable REST API contracts including endpoints, schemas, and responses, while JSDoc annotates JavaScript or TypeScript functions and interfaces inline. OpenAPI targets API consumers; JSDoc targets developers reading the code.

Can MkDocs generate documentation from Python docstrings?▼

Yes, the mkdocstrings plugin for MkDocs reads Python docstrings from your source paths and renders them as API reference pages. Configure the handler with your source directory in mkdocs.yml to enable automatic generation.

When should I not use automated documentation generation?▼

Avoid it for user guides, tutorials, and conceptual content, which require manual narrative writing. Automated generation suits API references and code-level documentation, not explanatory or onboarding material.

Related Skills

Explore More Software Engineering Skills→
mvillmowmvillmow
18

generate-api-docs

Generate HTML or Markdown API reference docs from docstrings.

Community
Intermediate
modu-aimodu-ai
1.2k

moai-docs-generation

Generates API references, user guides, and documentation sites using Sphinx, MkDocs, TypeDoc, and OpenAPI.

Official
Intermediate
nimadorostkarnimadorostkar
25

technical-documentation

Standardizes technical docs into tutorials, how-tos, references, and explanations.

Community
Intermediate
dhruvinrsonidhruvinrsoni

openapi-specs

Generate, validate, and detect drift in OpenAPI specifications from API code.

Community
Advanced