domains / software-engineering / code-documentation-generation / code-documentation-doc-generate

code-documentation-doc-generate

Skill card

combined

The sickn33 copy is a compatibility alias that reproduces the rmyndharis procedure but adds a worked example, explicit validation against routes/builds, and a limitations section. The rmyndharis copy includes a CI/linting automation step that the sickn33 copy explicitly defers. Because the copies disagree on whether to add automation and the sickn33 copy contains material steps (worked example, validation) not in the rmyndharis copy, crowning one would hide a real alternative.

Repositories

Other copies

Combined skill

---
name: code-documentation-doc-generate
description: "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."
---

# 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.
- Validate generated examples against actual routes and the current build.
- Add automation (linting, CI) 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.

## 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.

## Conflicts
- rmyndharis/antigravity-skills: Adds automation (linting, CI) as a standard step.
- sickn33/agentic-awesome-skills: Adds automation only when requested; emphasizes validation against routes/builds.