Automated summary
Analyzes a codebase to produce API documentation, user guides, and technical references, with consistent structure and automated accuracy checks.
Strengths
- Pulls information directly from code, config files, and inline comments
- Enforces consistent terminology and structure across every documentation type
- Covers automation via linting and CI so docs stay synchronized with the code
- Returns a documentation plan, file paths, and the required tooling configuration
Limitations
- Output quality depends entirely on access to the code and requirements; without a source of truth it stays generic
- Architecture diagrams are listed as a deliverable but no specific tool or format is defined
- Generated docs still need a manual technical accuracy review
Use it when an existing repository needs standardized documentation or when doc production should be automated and wired into CI.
Avoid it for one-off explanations or when neither the code nor the requirements are available.
Security analysis
SafeThe skill contains only documentation-generation guidance and explicitly advises avoiding secret exposure. It declares no tools and includes no destructive commands, network calls, credential handling, or obfuscated payloads.
No concerns found
How this analysis is madeExamples
Analyze the src/api directory of this repository and generate a complete API reference: every endpoint, its parameters, request/response schemas, and error codes. Output Markdown files under docs/api/ and tell me which paths you created.Set up an automated documentation pipeline for this repo: generate architecture docs from the code, add a Markdown linter, and wire both into our GitHub Actions workflow so docs are checked on every pull request.Our docs folder is inconsistent. Review the code and the existing files in docs/, then propose a unified structure with consistent terminology and regenerate the user guide to match it.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." risk: unknown source: community date_added: "2026-02-27"
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.mdfor detailed examples and templates.
From the file to a first result
The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.
View the source and supporting filesThis download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.
1. Download the file
Download SKILL.mdFrom the root of a test project, save the file as .skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.
Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.
mkdir -p '.skill-downloads/automated-documentation-generation-mrzxuqka' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/automated-documentation-generation-mrzxuqka/download' --output '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md.part' && mv '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md.part' '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md'2. Check prerequisites
Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.
Original excerpt: Requirements
$ARGUMENTS
The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.
3. Load the skill
After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.
Claude Code
test -f '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md' && test -s '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/code-documentation-doc-generate' && cp -R '.skill-downloads/automated-documentation-generation-mrzxuqka' '.claude/skills/code-documentation-doc-generate'Cursor
test -f '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md' && test -s '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/code-documentation-doc-generate' && cp -R '.skill-downloads/automated-documentation-generation-mrzxuqka' '.cursor/skills/code-documentation-doc-generate'Codex
test -f '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md' && test -s '.skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/code-documentation-doc-generate' && cp -R '.skill-downloads/automated-documentation-generation-mrzxuqka' '.agents/skills/code-documentation-doc-generate'OpenSkills
OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.
Official OpenSkills installationopenskills install './.skill-downloads/automated-documentation-generation-mrzxuqka'openskills read 'automated-documentation-generation-mrzxuqka'Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.
For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.
openskills syncManual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.
4. Try a first task
Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:
Read .skill-downloads/automated-documentation-generation-mrzxuqka/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.
Supabase Docs Authoring
Documentation
Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.
Create Architecture Decision Record
Documentation
Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.
Plan update with deep research
Documentation
Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.