← ClaudeAtlas

technical-writinglisted

Write clear, comprehensive technical documentation. Use when creating specs, architecture docs, runbooks, or API documentation. Handles technical specifications, system design docs, operational guides, and developer documentation with industry best practices.
aiskillstore/marketplace · ★ 329 · Code & Development · score 82
Install: claude install-skill aiskillstore/marketplace
# Technical Writing ## When to use this skill - Writing technical specifications - Creating architecture documentation - Documenting system designs - Writing runbooks and operational guides - Creating developer documentation - API documentation - User manuals and guides - Release notes and changelogs ## Instructions ### Step 1: Understand your audience **Developer audience**: - Focus on implementation details - Include code examples - Technical terminology is okay - Show how, not just what **DevOps/Operations audience**: - Focus on deployment and maintenance - Include configuration examples - Emphasize monitoring and troubleshooting - Provide runbooks **Manager/Stakeholder audience**: - High-level overview - Business impact - Minimal technical jargon - Focus on outcomes **End user audience**: - Simple, clear language - Step-by-step instructions - Visual aids (screenshots, videos) - FAQ section ### Step 2: Choose the right document type **Technical Specification**: ```markdown # [Feature Name] Technical Specification ## Overview Brief description of what this spec covers ## Problem Statement What problem are we solving? ## Goals and Non-Goals ### Goals - Goal 1 - Goal 2 ### Non-Goals - What we're explicitly not doing ## Solution Design ### High-Level Architecture ### Data Models ### API Contracts ### User Interface ## Implementation Plan ### Phase 1 ### Phase 2 ## Testing Strategy ## Security Considerations ## Performance Considerations ## Monitoring and Ale