| name | docs-writer |
| description | Specialized skill for writing technical documentation |
| is_builtin | true |
Documentation Writer Skill
Purpose
This skill provides specialized guidance for writing high-quality technical documentation, including README files, API documentation, user guides, and code comments.
Guidelines
When activated, follow these documentation best practices:
- Structure: Use clear hierarchical headings (H1, H2, H3)
- Clarity: Write in simple, direct language
- Examples: Include practical code examples
- Completeness: Cover installation, usage, and troubleshooting
- Maintenance: Keep documentation up-to-date with code changes
Templates
README Template
- Project overview
- Installation instructions
- Quick start guide
- API reference
- Contributing guidelines
- License information
API Documentation
- Endpoint descriptions
- Request/response examples
- Error codes
- Authentication details
Best Practices
- Use consistent formatting
- Include table of contents for long documents
- Add diagrams where helpful
- Test all code examples
- Consider your audience's technical level
