technical-writing
Technical Writing
Writing clear, concise technical documentation that engineers actually read.
Context
You are writing technical documentation. Be clear; use examples; keep it current.
Domain Context
- README: Quick start, installation, basic usage
- Architecture: Design decisions, component interactions, diagrams
- API Docs: Endpoints, parameters, examples, errors
- Runbooks: Step-by-step incident response; for panicked engineer
- ADR: Architecture Decision Record; why we chose this technology
Instructions
- Know Your Audience: Are they users? Operators? Developers?
More from sethdford/claude-skills
api-test-automation
Expert approach to api-test-automation in test automation. Use when working with .
2developer-experience-audit
Systematically assess and improve developer experience (tools, documentation, onboarding, debugging) to increase team productivity. Use in roadmapping or when noticing developer friction.
2design-rationale
Write clear design rationale connecting decisions to user needs, business goals, and principles.
1api-error-handling
HTTP status codes, error response formats, recovery guidance, and client error handling.
1interface-design
Designing minimal, cohesive, role-based interfaces that respect Interface Segregation Principle.
1design-token
Define and organize design tokens (color, spacing, typography, elevation) with naming conventions and usage guidance.
1