Creating a Culture of Documentation
summary
Documentation failures cost time and cause duplicated work: a Cornell study finds 61% of professionals struggle to know colleagues’ work, and Google reports 48% of engineers rank bad docs as their top productivity issue. Fixes that actually work put docs in source control, use markdown-based workflows with auto-rendering (G3 Docs, Docbird, Read the Docs, Sphinx), provide templates and doc days, require docs as a deliverable, and pair QA checks with documentation updates.
AI-written summary · about
chapters (20)
- 0:00Intro
- 1:15What is documentation
- 2:31Why is documentation important
- 5:15What makes for good documentation
- 6:50What makes for bad documentation
- 8:57What leads to bad documentation
- 10:59Consequences of bad documentation
- 13:21How to change your culture
- 19:49What if it doesnt work
- 21:37Tools for Documentation
- 28:39QA and Documentation
- 30:37How did you end up doing this
- 31:37Finding the right people
- 32:37Google Documentation
- 34:37Finding Documentation
- 37:37Stack Overflow
- 38:37Screenshots
- 40:37Screenshot
- 41:37Video Tutorials
- 42:37Camtasia
related talks
14mdocs docs docs
43mThe 7 Deadly Sins of Documentation
40mThe Knowledge: Towards a Culture of Engineering Documentation
20mDo Docs Better: Practical Tips on Delivering...
46mThe 7 Deadly Sins of Documentation
24mWho Writes the Docs?
01h 24mWriting Documentation - Practices and Theory
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?