technical-writing

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" - 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 - Focus on implementation details - Include code examples - Technical terminology is okay - Show how, not just what - Focus on deployment and maintenance - Include configuration examples - Emphasize monitoring and troubleshooting -...