technical-writing

Create clear, comprehensive technical documentation for specs, architecture, runbooks, and APIs. Developer audience : DevOps/Operations audience : Manager/Stakeholder audience : End user audience : Technical Specification : Architecture Document : Runbook : Symptoms : Response time > 1s Diagnosis : Check database connection pool Resolution : Restart service or scale up Symptoms : Memory usage growing over time Diagnosis : Check heap dump Resolution : Restart service, investigate in staging Parameters : Example Request : Example Response : Error Responses : Sequence diagrams : Flowcharts : Code blocks with syntax highlighting: Screenshots : Tables : Self-review checklist : Get feedback : Maintain documentation : Environment variables: [Deployment instructions] [Contributing guidelines] MIT ❌ Bad: "Configure the timeout parameter appropriately" ✅ Good: "To deploy: ❌ Bad: "Deploy by building and pushing the image to the registry, then update the deployment and verify the rollout succeeded" - Provides templates and step-by-step guidance for five document types: technical specifications, architecture documents, runbooks, API documentation, and changelogs - Includes audience-specific writing strategies for developers, operations teams, managers, and end users with tailored content focus - Offers visual aid support via Mermaid diagrams, flowcharts, tables, and code examples with...