What nobody tells you about documentation
summary
Clear claim: documentation breaks into four documentation types — tutorials, how‑tos, reference, explanations — and each must be written, organized and delivered separately. Evidence: Django restructures docs into those four sections; examples from a math library and aviation checklists show outcomes. Practical rules include tutorials must work every time and how‑tos focus on tasks while reference lists APIs and explanations give concepts. Result: easier maintenance, predictable reader paths, fewer support questions.
AI-written summary · about
chapters (12)
- 0:00Introduction
- 1:45About me
- 4:25Python Africa
- 5:48Everything you want the talk
- 6:50Why documentation is important
- 8:57The secret
- 9:46The structure
- 11:01Tutorials
- 13:40Learning
- 16:42Howto Guide
- 19:46Reference Guide
- 21:35Explanation
related talks
31mWhat nobody tells you about documentation
01h 24mWriting Documentation - Practices and Theory
28mImproving Your Documentation: A talk for developers who want to write stuff good
23mWriting Good Documentation for Developers
22mAudience, Market, Product
40mDocumentation as User Experience
13mTechnical documentation – how can I write them better and why should I care?
34mHumanizing Your Documentation