Technical Documentation
summary
A practical approach that cuts repeated support: a single “tips and tricks” doc reduces incoming questions from 7–8 times a day to 1–2, saving hours. Use runbooks to lower MTTR and avoid wake‑at‑night firefighting. Adopt docs-as-code: Markdown in the repo, PR review, CI checks for broken links, mermaid for diagrams. For Go, write package comments and executable Go examples run as tests and serve via pkg.go.dev. Enforce docs in the ticket Definition of Done to keep docs current.
AI-written summary · about
chapters (10)
- 0:00Introduction
- 2:32Why docs matter
- 5:42Code not self-documenting
- 6:44Benefits of technical documentation
- 12:04Writing technical docs
- 17:43Docs as code
- 21:15Go documentation
- 24:07Structuring technical documents
- 26:57Tips for better docs
- 28:01Golden rule
related talks
20mDo Docs Better: Practical Tips on Delivering...
01h 24mWriting Documentation - Practices and Theory
23mTwo Great Teams: Bridging the Gap Between Documentation and Customer Support
33mWhat The Doc?!?! How to Write and Read Documentation That Allows You To Get Sh*t Done!
25mBuilding Docs like Code: Continuous Integration for Documentation
45mDocs or it didn't happen!
44mPushing documentation (so it doesn't hurt anymore)
39mSave a Dev, Write a Doc!