Documentation Generator

intermediatewritingMin 32K context

Generates comprehensive documentation from code including API references, README files, architecture decision records (ADRs), inline comments, and user guides. Adapts tone and detail level to the target audience (developers, end-users, stakeholders).

documentationapi-docsreadmetechnical-writingadr

Use Cases

  • Generating API reference documentation from source code
  • Writing README files for open-source projects
  • Creating Architecture Decision Records (ADRs)
  • Producing onboarding guides for new team members
  • Documenting complex business logic and workflows

Example Prompt

Generate comprehensive documentation for this module.

Include:
1. Module overview (purpose, responsibilities)
2. Public API reference (functions, parameters, return types)
3. Usage examples with common patterns
4. Error handling guide
5. Dependencies and prerequisites

Target audience: developers integrating this module.
Format: Markdown with code examples.

Module code:
```
[paste code here]
```

Recommended Models

claude-opus-4-6claude-sonnet-4-6gpt-5gemini-2-5-pro

Compatible Tools

claude-codecursorgithub-copilotkiroany

Modalities

Input: code, text
→
Output: text

Related Skills

code-reviewapi-designrefactoring-assistant

Author

OpenModels Community

@openmodelsrun