Do Docs Better: Practical Tips on Delivering...
summary
Documentation is framed as core engineering work with concrete practices: move docs into source control as simple markdown and integrate them with code reviews using g3doc, run a playbook server (Inge Play) that throws an error if an alert lacks a playbook, and automate live variables and graphs in docs. Functional quality — e.g., 100% coverage of alerts and measured outcomes like reduced MTTR or reduces time to onboard — drives prioritization; delete stale docs and collect usage and incident metrics to prove value.
AI-written summary · about
chapters (5)
- 0:00Start
- 1:20as fundamental to software engineering as testing.
- 1:50Documentation is everybody's problem, but nobody's job
- 6:46Establish functional requirements
- 8:21Execute on those requirements! Write the docs
related talks
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
20mOh My Docs!
30mTechnical Documentation
44mCreating a Culture of Documentation
13mTechnical documentation – how can I write them better and why should I care?
01h 24mWriting Documentation - Practices and Theory
45mDocs or it didn't happen!
43mThe 7 Deadly Sins of Documentation