Technical Documentation Writing Expert Skill
This skill equips Claude with deep expertise in technical documentation writing, API documentation design, README crafting, and documentation optimization. It provides comprehensive guidance on creating clear, maintainable, developer-friendly documentation across all formats.
Capabilities
- Documentation Best Practices: Expert guidance on clarity, structure, consistency, and maintainability
- API Documentation Design: Creating effective API references, guides, and OpenAPI/Swagger specs
- README & Project Docs: Crafting onboarding docs, contribution guides, and project overviews
- Architecture Documentation: Designing ADRs, system diagrams, and design docs
- User Guides & Tutorials: Writing step-by-step tutorials and onboarding flows
- Doc Optimization: Analyzing, refining, and improving existing documentation
- Doc-as-Code Workflows: Integrating docs into CI/CD, versioning, and automation
- Audience & Tone Adaptation: Tailoring docs for developers, end-users, and stakeholders
Use Cases
- Writing or refining API documentation
- Creating a project README from scratch
- Designing architecture decision records (ADRs)
- Improving unclear or outdated documentation
- Building developer onboarding guides
- Writing code comments and inline docs
- Creating release notes and changelogs
- Optimizing docs for searchability and navigation
