docs

name	docs
description	Generate and update documentation

Documentation Skill

The Documentation Skill handles all documentation-related tasks for projects.

Requirements

1. Read AGENTS.md file before writing any documentation
2. Never repeat the instructions that appear in AGENTS.md
3. Use docs/ folder on project root for all documentation output. If it does not exist, create the folder.
4. Must ask user: "Would you like me to extract this info from AGENTS.md into the docs folder?"

Capabilities

README & Setup

• Generate README.md with project overview
• Write installation instructions
• Document configuration options
• Create environment setup guides
• Provide troubleshooting steps
• List dependencies and requirements

API Documentation

• Document REST API endpoints
• Describe request parameters and headers
• Define response schemas and status codes
• Generate OpenAPI/Swagger documentation
• Create API reference guides

Code Examples

• Create usage code snippets
• Provide implementation examples
• Write quickstart tutorials
• Show integration patterns
• Document common use cases

Feature Documentation

• Describe new features and functionality
• Write feature release notes
• Maintain changelog entries
• Document breaking changes
• Create migration guides

Best Practices

• Keep documentation in sync with code
• Use clear, concise language
• Include practical examples
• Structure content with headings and lists
• Update docs when making changes