Documentation: The Missing Pieces
summary
Shows exactly what to change in docs: spell out acronyms, write fully explicit step-by-step commands and replacements, and use explicit variable names in code samples. Demonstrates making tutorials runnable with provide Docker images or starter repos, estimating time and costs, and fixing broken links and screenshots with alt text. Covers jump-to sections and when to strip gifs. Practical, example-driven fixes and concrete checklist items you can apply immediately.
AI-written summary · about
chapters (6)
- 0:00Start
- 5:01Beginner's Programming Tutorial
- 9:52The German Naming Convention
- 11:15Tell Me What I Need
- 17:40No More 404s
- 26:09Recap
related talks
33mDocumentation: The Missing Pieces
51mWriting the Darn Docs
01h 24mWriting Documentation - Practices and Theory
37mHumanising Your Documentation
28mImproving Your Documentation: A talk for developers who want to write stuff good
01h 14mTechnically speaking: Improve Your Code With Documentation
46mSave a Dev, Write Documentation!
29mHumanizing Your Documentation