| name | documentation |
| description | Create and maintain high-quality documentation using the librarian subagent. Use when writing docs, READMEs, API documentation, code summaries, or any text-based artifacts. |
Documentation
Trigger: Use when writing docs, READMEs, API documentation, code summaries,
or any text-based artifacts. Or when user says "document", "write docs", "README",
"explain this".
Purpose
Create and maintain high-quality documentation using the librarian subagent.
Documentation Types
README
- Project overview
- Setup/installation instructions
- Quick start guide
- Key features
- Contributing guidelines
API Documentation
- Function signatures with types
- Parameter descriptions
- Return values
- Usage examples
- Error cases
Architecture Docs
- System overview diagram (text-based)
- Module descriptions
- Data flow
- Key design decisions
Code Summaries
- Purpose of module
- Key exports
- Dependencies
- Notable patterns
How to Run
Use the librarian subagent to [document/create/update] [target]
Documentation Standards
- Clear, concise, developer-focused
- Structured with headings and code examples
- Accurate — verify against actual code
- Current — note potential staleness