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