documentation-generation-doc-generate

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

5 stars

Best use case

documentation-generation-doc-generate is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

Teams using documentation-generation-doc-generate should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/documentation-generation-doc-generate/SKILL.md --create-dirs "https://raw.githubusercontent.com/FrancoStino/opencode-skills-collection/main/bundled-skills/documentation-generation-doc-generate/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/documentation-generation-doc-generate/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How documentation-generation-doc-generate Compares

Feature / Agentdocumentation-generation-doc-generateStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Automated Documentation Generation

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

## Use this skill when

- Generating API, architecture, or user documentation from code
- Building documentation pipelines or automation
- Standardizing docs across a repository

## Do not use this skill when

- The project has no codebase or source of truth
- You only need ad-hoc explanations
- You cannot access code or requirements

## Context
The user needs automated documentation generation that extracts information from code, creates clear explanations, and maintains consistency across documentation types. Focus on creating living documentation that stays synchronized with code.

## Requirements
$ARGUMENTS

## Instructions

- Identify required doc types and target audiences.
- Extract information from code, configs, and comments.
- Generate docs with consistent terminology and structure.
- Add automation (linting, CI) and validate accuracy.
- If detailed examples are required, open `resources/implementation-playbook.md`.

## Safety

- Avoid exposing secrets, internal URLs, or sensitive data in docs.

## Output Format

- Documentation plan and artifacts to generate
- File paths and tooling configuration
- Assumptions, gaps, and follow-up tasks

## Resources

- `resources/implementation-playbook.md` for detailed examples and templates.

## Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

Related Skills

unit-testing-test-generate

5
from FrancoStino/opencode-skills-collection

Generate comprehensive, maintainable unit tests across languages with strong coverage and edge case focus.

podcast-generation

5
from FrancoStino/opencode-skills-collection

Generate real audio narratives from text content using Azure OpenAI's Realtime API.

openapi-spec-generation

5
from FrancoStino/opencode-skills-collection

Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.

fal-generate

5
from FrancoStino/opencode-skills-collection

Generate images and videos using fal.ai AI models

documentation

5
from FrancoStino/opencode-skills-collection

Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.

documentation-templates

5
from FrancoStino/opencode-skills-collection

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

code-documentation-doc-generate

5
from FrancoStino/opencode-skills-collection

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

code-documentation-code-explain

5
from FrancoStino/opencode-skills-collection

You are a code education expert specializing in explaining complex code through clear narratives, visual diagrams, and step-by-step breakdowns. Transform difficult concepts into understandable explanations for developers at all levels.

apify-lead-generation

5
from FrancoStino/opencode-skills-collection

Scrape leads from multiple platforms using Apify Actors.

api-documentation

5
from FrancoStino/opencode-skills-collection

API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.

api-documentation-generator

5
from FrancoStino/opencode-skills-collection

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

zustand-store-ts

5
from FrancoStino/opencode-skills-collection

Create Zustand stores following established patterns with proper TypeScript types and middleware.