---
name: technical-documentation
description: Create clear technical documentation including READMEs, API docs, and
  architecture guides. Use when documenting code, APIs, systems, or processes.
metadata:
  source: nuday
  catalog: platform
  category: documentation
  priority: '20'
---

# Technical Documentation

## Overview
This skill helps create clear, comprehensive technical documentation.

## Documentation Types

### README Files
Structure:
1. **Title & Description**: What the project does
2. **Quick Start**: Get running in 5 minutes
3. **Installation**: Detailed setup instructions
4. **Usage**: Common use cases with examples
5. **Configuration**: Available options
6. **API Reference**: If applicable
7. **Contributing**: How to contribute
8. **License**: Terms of use

### API Documentation
Include for each endpoint:
- HTTP method and path
- Description
- Request parameters (path, query, body)
- Response schema and examples
- Error codes and meanings
- Authentication requirements
- Rate limiting info

### Architecture Documentation
- System overview diagram
- Component descriptions
- Data flow diagrams
- Integration points
- Deployment architecture
- Security considerations

## Writing Guidelines

### Clarity
- Use simple, direct language
- Define technical terms
- Include examples
- Use consistent terminology

### Structure
- Use headings and sections
- Include a table of contents for long docs
- Use bullet points for lists
- Add code blocks for examples

### Maintenance
- Keep documentation near code
- Update with code changes
- Include last-updated dates
- Version documentation with releases