code-documentation-doc-generate

Generate API documentation, architecture diagrams, and user guides from code.

2|Updated Feb 6, 2026
One-click install
npx skills add https://github.com/bcastelino/agent-skills-kit --skill code-documentation-doc-generate-bcastelino
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documentation-doc-generate
Source: https://github.com/bcastelino/agent-skills-kit/tree/main/skills/code-documentation-doc-generate
Command: npx skills add https://github.com/bcastelino/agent-skills-kit --skill code-documentation-doc-generate-bcastelino

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive documentation directly from your codebase, ensuring your projects are well-documented and maintainable.

Core Features & Use Cases

  • API Documentation Generation: Creates OpenAPI/Swagger specs and interactive docs from code.
  • Architecture Diagrams: Generates visual representations of your system's architecture.
  • Code & User Guides: Produces inline documentation, READMEs, and step-by-step user tutorials.
  • Use Case: Automatically generate API documentation for a new microservice, including diagrams and a user guide, to onboard new developers quickly.

Quick Start

Use the code-documentation-doc-generate skill to generate API documentation for the provided codebase.

Frequently Asked Questions about code-documentation-doc-generate

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

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

You can generate API documentation automatically by analyzing your code, configurations, and comments to produce OpenAPI specs, interactive docs, and technical references. This creates living documentation synchronized directly with your codebase.

What types of documentation can I generate for a new microservice?

For a new microservice, you can generate API documentation, architecture diagrams, user guides, and technical references. This comprehensive output helps onboard new developers quickly by providing visual system representations and step-by-step tutorials.

Does automated code documentation work with architecture diagrams?

Yes, automated code documentation generates visual representations of your system's architecture diagrams. It analyzes your underlying codebase to ensure these visual diagrams accurately reflect your current technical structure.

How do I keep my README and user guides synchronized with my codebase?

You can keep READMEs and user guides synchronized by generating living documentation directly from your code. The automation analyzes your code and comments to ensure your inline documentation and tutorials remain consistently accurate.

What's the best way to create technical references without manual writing?

The best way to create technical references without manual writing is using automation to extract details directly from code and configurations. This produces consistent, accurate technical writing synchronized with your actual codebase.