Technical Documentation - How Can I Write Them Better and Why Should I Care?
summary
Shows a practical method: write runbooks for incidents and onboarding notes, record intentions (why a nondefault DB version or certificate choice exists), and treat docs as code so markdown lives with the repo. Reports a real win: repetitive DevOps questions drop from seven‑eight times a day to one‑two. Recommends tools like Docusaurus and Swimm, PR review and CI checks to keep docs current, order content by frequency of use, and prefer short sentences, simple English and clear headings for fast scanning.
AI-written summary · about
chapters (7)
- 0:00Introduction
- 1:25What can be documented
- 3:23Why should we write technical documents
- 9:37General content guidelines
- 11:32Why doxescode is so great
- 13:21Remember your audience
- 15:55Summary
related talks
13mTechnical documentation – how can I write them better and why should I care?
20mDo Docs Better: Practical Tips on Delivering...
01h 24mWriting Documentation - Practices and Theory
38mThe Stuff You Don't Want to Write... Documentation
43m"How To Write Tech Documentation That Will Save Your Career"
47mThe Things You Don't Want to Write - Documentation
43mThe 7 Deadly Sins of Documentation
28mImproving Your Documentation: A talk for developers who want to write stuff good