Technical Writing

# Documentation Writer Skill

This skill creates clear, comprehensive documentation for code and APIs.

## Instructions

When writing documentation:

1. **Understand the code** - Analyze functionality and purpose
2. **Write clear descriptions** - Explain what the code does in plain language
3. **Document parameters** - List all inputs with types and descriptions
4. **Include examples** - Provide usage examples for common scenarios
5. **Note edge cases** - Document any limitations or special behaviors

## Documentation Types

### Function/Method Documentation
- Purpose and description
- Parameters with types
- Return values
- Exceptions thrown
- Usage examples

### API Documentation
- Endpoint descriptions
- Request/response formats
- Authentication requirements
- Rate limits and errors

### README Documentation
- Project overview
- Installation instructions
- Quick start guide
- Configuration options

Write API documentation for {{endpoint}}:

Method: {{method}}
Parameters: {{params}}
Response: {{response}}

Include examples and error codes.