What Dante never wrote: A Divine guide to documenting the code Inferno
summary
A practical, entertaining guide to improving software documentation that identifies common “sins” (messiness, forgetfulness, verbosity), shows how to fix and restructure docs (the purgatory stage), and explains how to reach clear, useful documentation. It covers specific document types—RPDs, RFCs, ADRs, and Tech Specs—and focuses on making documentation actually work and be read.
AI-written summary · about
chapters (10)
- 0:00Introduction to documentation
- 3:13Why document code
- 8:47Benefits of technical docs
- 14:21Effective document structure
- 20:14Analysis and solutions
- 27:15Key document types
- 32:31Postmortem and learning
- 37:24Docs for career growth
- 39:32Documenting as art
- 40:56Sharing docs channels
related talks
01h 24mWriting Documentation - Practices and Theory
46mThe 7 Deadly Sins of Documentation
43mThe 7 Deadly Sins of Documentation
51mWriting the Darn Docs
46mSave a Dev, Write Documentation!
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
39mSave a Dev, Write a Doc!
53mThe Emperor Has No Docs