Documentation
README
Doc Writer: Generate Documentation
Create clear, well-structured documentation for the specified code, project, or topic.
Process
Step 1: Understand the Target
- If a file/project path is given, read the code first using Read/Glob tools
- Identify the audience (developers, end users, API consumers)
- Understand the scope (single function, module, full project)
Step 2: Generate Documentation
Choose the appropriate format:
For a Project (README)
- Project name and one-line description
- Features list
- Quick start / installation instructions
- Usage examples with code blocks
- Configuration options (if any)
- License info
This is the opening of the README. Read the full README on GitHub.