Step 1: Identify Documentation Type
Determine documentation type:
API Documentation: Endpoint references Developer Guide: Setup and usage Architecture Docs: System overview User Manual: Feature guides Step 2: Extract Information
Gather documentation content:
Read code and comments Analyze API endpoints Extract examples Understand architecture Step 3: Generate Documentation
Create documentation:
Follow documentation templates Include examples Add troubleshooting Create clear structure Step 4: Validate Documentation
Validate quality:
Check completeness Verify examples work Ensure clarity Validate links
Integration with Developer Agent:
Generates API documentation Creates inline documentation Updates docs with code changes
Extract from Code: Use code as source of truth Include Examples: Provide working examples Keep Updated: Sync docs with code Clear Structure: Organize logically User-Focused: Write for users, not system
Users API
Endpoints
GET /api/users
List all users with pagination.
Query Parameters:
page(number): Page number (default: 1)limit(number): Items per page (default: 10)
Response:
{
"data": [
{
"id": "uuid",
"email": "user@example.com",
"name": "User Name"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 100
}
}
Example:
curl -X GET "http://localhost:3000/api/users?page=1&limit=10"
```markdown
Developer Guide
Getting Started
Prerequisites
- Node.js 18+
- pnpm 8+
Installation
```bash pnpm install
Development pnpm dev
Architecture
[Architecture overview]
Development Workflow
[Development process]
Generate API documentation
Generate API documentation for app/api/users
Generate developer guide
Generate developer guide for this project
Generate architecture docs
Generate architecture documentation
Generate OpenAPI spec
Generate OpenAPI specification from API routes
Memory Protocol (MANDATORY)
Before starting:
Read .claude/context/memory/learnings.md
After completing:
- New pattern -> .claude/context/memory/learnings.md
- Issue found -> .claude/context/memory/issues.md
- Decision made -> .claude/context/memory/decisions.md
ASSUME INTERRUPTION: If it's not in memory, it didn't happen.