docs-generate

Included with Lifetime

$97 forever

Generate or update docs from code annotations, docstrings, and git history. Use when wanting API reference, README from code, or CHANGELOG from conventional commits.

Backend & APIs

What this skill does


## When to Use This Skill

| Use this skill when... | Use docs-sync instead when... |
|---|---|
| Generating fresh API reference docs from docstrings, type signatures, and module structure | Reconciling existing skill/command/agent catalogs with the current codebase |
| Updating README.md from code analysis (installation steps, feature list, badges) | Fixing wrong counts or stale entries in CLAUDE.md / README catalogs |
| Producing a CHANGELOG from conventional-commit history | Preparing a service teardown checklist (use docs-decommission) |
| Building documentation pages that will be served via GitHub Pages or similar | Converting Markdown to print-ready PDF (use docs-latex) |

## Context

- Project files: !`find . -maxdepth 1 \( -name 'pyproject.toml' -o -name 'package.json' -o -name 'Cargo.toml' -o -name 'go.mod' \)`
- Existing docs: !`find . -maxdepth 1 \( -name 'README.md' -o -type d -name 'docs' \)`
- Source files: !`find . -type f \( -name "*.py" -o -name "*.ts" -o -name "*.js" \)`
- Python with docstrings: !`grep -r "\"\"\"" --include="*.py" -l`

## Parameters

- `--api`: Generate API reference documentation
- `--readme`: Update README.md based on code analysis
- `--changelog`: Update CHANGELOG.md from git history

## Your task

**Delegate this task to the `documentation` agent.**

Use the Agent tool with `subagent_type: documentation` to generate or update project documentation. Pass all the context gathered above and the parsed parameters to the agent.

The documentation agent should:

1. **Analyze codebase**:
   - Extract docstrings and type annotations
   - Identify public API surface
   - Map module structure and dependencies
   - Find usage examples in tests

2. **Generate requested documentation**:

   If `--api`:
   - Create API reference from docstrings
   - Document function signatures and types
   - Include usage examples
   - Generate module hierarchy

   If `--readme`:
   - Update project description
   - Document installation steps
   - Add usage examples
   - Update feature list
   - Ensure badges are current

   If `--changelog`:
   - Parse conventional commits
   - Group by version/release
   - Categorize by type (feat, fix, docs, etc.)
   - Include breaking changes prominently

   If no flags: Generate all documentation

3. **Follow documentation standards**:
   - Clear, concise language
   - Consistent formatting
   - Working code examples
   - Accurate cross-references

4. **Output summary**:
   - Files created/updated
   - Documentation coverage metrics
   - Suggested improvements

Provide the agent with:
- All context from the section above
- The parsed parameters
- Detected documentation framework (if any)

The agent has expertise in:
- Multi-language documentation extraction
- API reference generation
- README best practices
- Changelog automation from commits
- GitHub Pages integration

## Agent Teams (Optional)

For large projects, spawn teammates for parallel documentation generation:

| Teammate | Focus | Value |
|----------|-------|-------|
| API docs teammate | Extract and generate API reference | Parallel with README generation |
| README teammate | Update project README and guides | Parallel with API docs |
| Changelog teammate | Generate changelog from git history | Independent of other doc tasks |

This is optional — the skill works with a single agent for most projects.

Files: 1

Size: 3.7 KB

Complexity: 12/100

Category: Backend & APIs

Source: https://github.com/laurigates/claude-plugins/tree/main/documentation-plugin/skills/docs-generate

Related in Backend & APIs

jfrog

Included

Interact with the JFrog Platform via the JFrog CLI and REST/GraphQL APIs. Use this skill when the user wants to manage Artifactory repositories, upload or download artifacts, manage builds, configure permissions, manage users and groups, work with access tokens, configure JFrog CLI servers, search artifacts, manage properties, set up replication, manage JFrog Projects, run security audits or scans, look up CVE details, query exposures scan results from JFrog Advanced Security, manage release bundles and lifecycle operations, aggregate or export platform data, or perform any JFrog Platform administration task. Also use when the user mentions jf, jfrog, artifactory, xray, distribution, evidence, apptrust, onemodel, graphql, workers, mission control, curation, advanced security, exposures, or any JFrog product name.

Backend & APIsscripts

cupynumeric-migration-readiness

Included

Pre-migration readiness assessor for porting NumPy to cuPyNumeric. Use BEFORE substantial porting work begins when the user asks whether code will scale on GPU, whether they should migrate to cuPyNumeric, which NumPy patterns transfer cleanly, what must be refactored before porting, or mentions pre-port assessment, scaling analysis, or refactor planning. Inspect the user's source code, look up NumPy usage, cross-reference the cuPyNumeric API support manifest, and distinguish distributed-scaling-friendly patterns from blockers such as unsupported APIs, scalar synchronization, host round-trips, Python/object-heavy control flow, shape/data-dependent branching, and in-place mutation hazards. Produce a verdict of READY, LIGHT REFACTOR, SIGNIFICANT REFACTOR, or NOT RECOMMENDED, with concrete refactor pointers.

Backend & APIsscripts

alibabacloud-data-agent-skill

Included

Invoke Alibaba Cloud Apsara Data Agent for Analytics via CLI to perform natural language-driven data analysis on enterprise databases. Data Agent for Analytics is an intelligent data analysis agent developed by Alibaba Cloud Database team for enterprise users. It automatically completes requirement analysis, data understanding, analysis insights, and report generation based on natural language descriptions. This tool supports: discovering data resources (instances/databases/tables) managed in DMS, initiating query or deep analysis sessions, real-time progress tracking, and retrieving analysis conclusions and generated reports. Use this Skill when users need to query databases, analyze data trends, generate data reports, ask questions in natural language, or mention "Data Agent", "data analysis", "database query", "SQL analysis", "data insights".

Backend & APIsscripts

token-optimizer

Included

Reduce OpenClaw token usage and API costs through smart model routing, heartbeat optimization, budget tracking, and native 2026.2.15 features (session pruning, bootstrap size limits, cache TTL alignment). Use when token costs are high, API rate limits are being hit, or hosting multiple agents at scale. The 4 executable scripts (context_optimizer, model_router, heartbeat_optimizer, token_tracker) are local-only — no network requests, no subprocess calls, no system modifications. Reference files (PROVIDERS.md, config-patches.json) document optional multi-provider strategies that require external API keys and network access if you choose to use them. See SECURITY.md for full breakdown.

Backend & APIsscripts

resend-cli

Included

Use this skill when the task is specifically about operating Resend from an AI agent, terminal session, or CI job via the official resend CLI: installing/authenticating the CLI, sending/listing/updating/cancelling emails, batch sends, domains and DNS, webhooks and local listeners, inbound receiving, contacts, topics, segments, broadcasts, templates, API keys, profiles, or debugging Resend CLI/API failures. Trigger on mentions of Resend CLI, `resend`, `resend doctor`, `resend emails send`, `resend domains`, `resend webhooks listen`, `resend emails receiving`, or agent-friendly terminal automation.

Backend & APIsscripts

alibabacloud-odps-maxframe-coding

Included

Use this skill for MaxFrame SDK development and documentation navigation on Alibaba Cloud MaxCompute (ODPS). Helps answer MaxFrame API, concept, official example, and supported pandas API questions; create data processing programs; read/write MaxCompute tables; debug jobs (remote or local); and build custom DPE runtime images. Trigger when users mention MaxFrame, MaxCompute with MaxFrame, ODPS table processing, DPE runtime, MaxFrame docs/examples, DataFrame/Tensor operations, or GPU runtime setup. Works for both English and Chinese queries about Alibaba Cloud data processing with MaxFrame.

Backend & APIsscripts