Technical Writing

Technical Writing

Write clearly as an engineer. Documentation, Architecture Decision Records, RFCs, technical proposals, README files, runbooks, and communicating complex ideas to both technical and non-technical audiences.

FundamentalsTopics 1–10
  • ·Why Engineers Should Write
  • ·Audience Awareness
  • ·Clarity Over Cleverness
  • ·Structuring Technical Docs
  • ·API Documentation
  • ·README Best Practices
  • ·Diagrams & Visuals
  • ·Code Comments vs Docs
  • ·Versioning Documentation
  • ·Docs-as-Code Workflow
Start Fundamentals →
IntermediateTopics 11–20
  • ·Architecture Decision Records
  • ·RFCs & Design Documents
  • ·Runbooks & Playbooks
  • ·Incident Post-mortems
  • ·Technical Blog Posts
  • ·Writing for Multiple Audiences
  • ·Changelogs
  • ·Internal Wiki Best Practices
  • ·Onboarding Documentation
  • ·The Review Process
Start Intermediate →
AdvancedTopics 21–30
  • ·Documentation Sites
  • ·OpenAPI Spec Writing
  • ·Open Source Documentation
  • ·Technical SEO for Docs
  • ·Accessibility in Docs
  • ·Measuring Documentation Quality
  • ·Docs at Scale
  • ·Developer Portals
  • ·Localisation & Translation
  • ·Advanced Docs-as-Code
Start Advanced →
AppliedTopics 31–38
  • ·Writing an ADR
  • ·Creating an API Reference
  • ·Incident Report Template
  • ·Engineering Blog Launch
  • ·Open Source README
  • ·Technical Spec Review
  • ·Documentation Sprint Planning
  • ·Writing Culture
Start Applied →