Documentation Generator

СреднийwritingМинимальный контекст: 32K

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

Варианты использования

  • 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

Пример промпта

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

Рекомендуемые модели

Совместимые инструменты

claude-codecursorgithub-copilotkiroany

Модальности

Вход: code, text
Выход: text

Похожие Skills

Автор

OpenModels Community

@openmodelsrun