Documentation Skill

Goal

Generate accurate, useful documentation for public APIs, modules, and the project README. Documentation describes WHY and WHAT (not HOW — the code shows how). All examples must be working code.

Steps

1. Identify what needs documentation

   • Public functions, methods, and classes (not private internals)
   • API endpoints (generate from OpenAPI spec or create if missing)
   • Complex business logic with non-obvious behavior
   • README sections that are outdated or missing

2. Write function/method docstrings