Documentation Generator

OrtawritingEn az 32K bağlam

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

Kullanım alanları

  • 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

Örnek 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]
```

Önerilen modeller

Uyumlu araçlar

claude-codecursorgithub-copilotkiroany

Modaliteler

Giriş: code, text
Çıkış: text

İlgili Skills

Yazar

OpenModels Community

@openmodelsrun