# documentation-generator

The documentation-generator command turns code, APIs, and project details into structured developer documentation. Use it when setup notes, examples, or endpoint references need to be written.

- command · `type=command` · Claude Code, Codex, GitHub Copilot, Gemini CLI · ★ 2003 repo stars
- Author: Community
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/composio-community/awesome-claude-plugins/tree/HEAD/documentation-generator/commands/documentation-generator.md
- Updated: 2026-07-26
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/commands/documentation-generator

## What it does

The command asks Claude Code to document functions and methods with their inputs and returned values, then add usage examples, edge cases, error handling, and performance notes. For APIs, it covers endpoints, HTTP methods, request and response schemas, authentication, rate limits, error codes, and interactive examples.

It can also shape project documentation around installation, setup, configuration, troubleshooting, and contribution guidance. The output uses Markdown and practical examples. That scope is too broad for a short one-off note.

Run the slash command and point it at the code, API, or project to document. The material you provide determines which sections the agent can fill in.

## Install

### Claude Code (native platform)

1. **Plugin marketplace**
In the agent chat (not a shell):
```text
/plugin marketplace add composio-community/awesome-claude-plugins
```
In the agent chat (not a shell):
```text
/plugin install documentation-generator@awesome-claude-plugins
```

2. **Manually: put the files in place**
- File: `.claude/commands/documentation-generator.md` — Call it with /documentation-generator. For all projects use ~/.claude/commands/

### Codex

**Manually: put the files in place**
- File: `~/.codex/prompts/documentation-generator.md` — Call it with /prompts:documentation-generator. Codex marks this format deprecated in favour of skills

### GitHub Copilot

**Manually: put the files in place**
- File: `.github/prompts/documentation-generator.prompt.md`

### Gemini CLI

**Manually: put the files in place**
- File: `.gemini/commands/documentation-generator.toml` — Gemini stores commands as TOML: the prompt text goes into the prompt field

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/composio-community/awesome-claude-plugins/tree/HEAD/documentation-generator/commands/documentation-generator.md

## When to use it
- document functions with parameters and return values
- describe API endpoints and their HTTP methods
- add usage examples and edge-case handling
- write project setup and installation instructions
- organize configuration and troubleshooting notes

## Example prompts
- \`/documentation-generator` Document the functions in `src/auth.py`, including parameters, return values, and call examples.
- \`/documentation-generator` Create API docs with endpoint methods, request and response schemas, authentication details, rate limits, and error codes.
- \`/documentation-generator` Draft project documentation covering installation, setup, configuration, troubleshooting, and contribution guidance.

## Similar
- [generate-api-documentation](https://affpapa.org/en/nevibecode/commands/generate-api-documentation.md) — command · 1849 installs
- [documentation-engineer](https://affpapa.org/en/nevibecode/agents/documentation-engineer.md) — subagent · 735 installs
- [documentation](https://affpapa.org/en/nevibecode/skills/documentation.md) — skill · 10800 installs
- [code-documentation](https://affpapa.org/en/nevibecode/skills/aj-geddes-code-documentation.md) — skill · 502 installs
- [documentation-templates](https://affpapa.org/en/nevibecode/skills/documentation-templates.md) — skill · 305 installs
- [code-documentation-analyzer](https://affpapa.org/en/nevibecode/skills/code-documentation-analyzer.md) — skill · 1 install

From the same set: [composio-community/awesome-claude-plugins](https://affpapa.org/en/nevibecode/by/composio-community/awesome-claude-plugins.md) — 68 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
