DO

documentation-generation-doc-generate

Automated documentation generation for APIs, architecture, and technical guides.

Install

mkdir -p .claude/skills/documentation-generation-doc-generate && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/2643" && unzip -o skill.zip -d .claude/skills/documentation-generation-doc-generate && rm skill.zip

Installs to .claude/skills/documentation-generation-doc-generate

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

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.
243 charsno explicit “when” trigger
Beginner

Key capabilities

  • →Extracts architectural patterns from codebases
  • →Generates consistent documentation across multiple formats
  • →Links code implementation to technical references
  • →Configures CI pipelines for documentation maintenance

How it works

It parses source code, configurations, and comments using an analytical model to synthesize structured documentation artifacts aligned with industry standards.

Inputs & outputs

You give it
Repository path or codebase reference
You get back
API docs, architecture diagrams, and user guide markdown

When to use documentation-generation-doc-generate

  • →Generating API documentation
  • →Creating architecture diagrams
  • →Standardizing technical references

About this skill

Compatibility and maintenance

Primary editorial path for this compatibility group. The full instructions and support files remain local so existing installations continue to work offline. This is one shared procedure, not an additional capability. Preserve the callable ID when an existing manifest or client configuration uses it. Modified in AAS on 2026-09-05; original metadata and license notices are retained.

Automated Documentation Generation

Produce the documentation requested for a named audience and source revision. Use implementation, configuration and tests as evidence; distinguish observed behavior from proposed changes.

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. Document the checked revision and the existing verification command; a generated document does not stay synchronized automatically.

Requirements

$ARGUMENTS

Instructions

  • Identify the requested artifact, target audience and current source revision. Do not generate every artifact in the playbook by default.
  • Extract information from code, configs, and comments.
  • Generate docs with consistent terminology and structure.
  • Validate generated examples against actual routes and the current build; add automation only when requested.
  • If detailed examples are required, open resources/implementation-playbook.md.

Worked example and prerequisites

For an endpoint changed to return a cursor, inspect its implementation and test fixtures, update the response example and pagination explanation, then run the existing schema/doc build and the documented read-only call against a test fixture. Record which commands actually ran. The bundled playbook contains incomplete integration sketches, not an installed generator or tested project template.

Example acceptance criteria

For that cursor-pagination update, the deliverable is the affected endpoint page and response example, not a new documentation platform. Confirm the cursor field name, final-page value, invalid-cursor response and authentication requirement against implementation or fixtures. Keep missing evidence in a short gaps list. Report schema/build/link checks as run, failed or unrun with a reason; an illustrative response is not a successful API call.

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.

When not to use it

  • →When documentation requirements are purely unstructured narrative
  • →When the target code lacks consistent internal structure or comments

Limitations

  • →Cannot infer business intent not present in the code
  • →Requires well-commented source code for high-quality output

How it compares

It focuses on creating 'living' documentation that remains synchronized with the codebase via automation rather than static writing.

Compared to similar skills

documentation-generation-doc-generate side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
documentation-generation-doc-generate (this skill)47moNo flagsBeginner
docs-review1011moNo flagsBeginner
claude-md-improver2110moReviewBeginner
backend-to-frontend-handoff-docs310moNo flagsBeginner

Try saying

Example prompts that trigger this skill in your AI assistant.

mobile-design

sickn33

Mobile-first design and engineering doctrine for iOS and Android apps. Covers touch interaction, performance, platform conventions, offline behavior, and mobile-specific decision-making. Teaches principles and constraints, not fixed layouts. Use for React Native, Flutter, or native mobile apps.

149231

unity-developer

sickn33

Build Unity games with optimized C# scripts, efficient rendering, and proper asset management. Masters Unity 6 LTS, URP/HDRP pipelines, and cross-platform deployment. Handles gameplay systems, UI implementation, and platform optimization. Use PROACTIVELY for Unity performance issues, game mechanics, or cross-platform builds.

142357

architect-review

sickn33

Master software architect specializing in modern architecture patterns, clean architecture, microservices, event-driven systems, and DDD. Reviews system designs and code changes for architectural integrity, scalability, and maintainability. Use PROACTIVELY for architectural decisions.

109320

angular

sickn33

Modern Angular (v20+) expert with deep knowledge of Signals, Standalone Components, Zoneless applications, SSR/Hydration, and reactive patterns. Use PROACTIVELY for Angular development, component architecture, state management, performance optimization, and migration to modern patterns.

100129

frontend-slides

sickn33

Create stunning, animation-rich HTML presentations from scratch or by converting PowerPoint files. Use when the user wants to build a presentation, convert a PPT/PPTX to web, or create slides for a talk/pitch. Helps non-designers discover their aesthetic through visual exploration rather than abstract choices.

95195

minecraft-bukkit-pro

sickn33

Master Minecraft server plugin development with Bukkit, Spigot, and Paper APIs. Specializes in event-driven architecture, command systems, world manipulation, player management, and performance optimization. Use PROACTIVELY for plugin architecture, gameplay mechanics, server-side features, or cross-version compatibility.

9078

You might also like

Search skills

Search the agent skills registry