documentation

Generate and update project documentation from code and OpenAPI schemas.

47|8|Updated Sep 13, 2025
One-click install
npx skills add https://github.com/lvndry/jazz --skill documentation-lvndry
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/lvndry/jazz/tree/main/skills/documentation
Command: npx skills add https://github.com/lvndry/jazz --skill documentation-lvndry

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams keep documentation in sync with code, APIs, and project context by generating and updating docs automatically.

Core Features & Use Cases

  • Generate README files from project context, code annotations, and API schemas
  • Create API reference docs from OpenAPI specs and code comments
  • Update docs automatically after code changes, deployments, or API updates
  • Use Case: you add a new module; generate README, API references, and inline docs to keep everything current

Quick Start

Point the skill at your project directory and trigger documentation generation. Start with a README and an API reference, then iterate as the codebase evolves.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate README files and API references directly from code?

You can generate README files and API references by pointing the skill at your project directory to read code metadata, types, and OpenAPI schemas, producing documentation that stays current with changes.

Can I automatically update documentation after code changes or API updates?

Yes, you can update documentation automatically after code changes, deployments, or API updates by triggering the skill to regenerate README files, API references, and inline docs from the latest project context.

Does this documentation generator work with OpenAPI specs?

Yes, the documentation generator works with OpenAPI schemas by reading the specs and code comments to create accurate API reference docs, verifying links and examples for accuracy.

How do I keep inline docs in sync with my codebase as it evolves?

You keep inline docs in sync by running the skill to read code metadata and project context, generating updated documentation that reflects new modules, types, and API changes as the codebase evolves.

Do I need any specific dependencies to generate docs from code and APIs?

No dependencies are required to generate docs from code and APIs. The skill operates independently to read project context, code annotations, and OpenAPI schemas to produce README files and API references.

What formats are supported for generating API reference documentation?

The skill supports multiple output formats for generating API reference documentation from OpenAPI specs and code comments, while verifying links and examples to ensure accuracy across all generated docs.