Writing So Your Words Are Read
summary
Argues that documentation wins when it targets real readers not clones of the author and gives concrete tactics: use human writing, add tutorials that handhold to an early success moment, link unfamiliar terms, show filenames, style code with highlighting, and use screenshots/GIFs. Cites examples: Stripe’s interactive walkthrough, Django REST framework’s progressive tutorials, Requests and Fabric docs for clear intros. Built beginner-friendly Python/Django books (Kickstarter then Amazon with positive reviews) and a Django web app, all reinforcing that these techniques work.
AI-written summary · about
chapters (5)
- 0:00Introduction and background
- 7:46Writing for all skill levels
- 17:55Simplifying and teaching
- 25:42Formatting and visual aids
- 28:25Conclusion and accessibility
related talks
31mWhat nobody tells you about documentation
01h 24mWriting Documentation - Practices and Theory
48mBeyond Words: Crafting User-Friendly Documentation
01h 01mRight the docs
28mImproving Your Documentation: A talk for developers who want to write stuff good
52mTechnically Speaking: improve your code with documentation
45mDocs or it didn't happen!
33mWhat The Doc?!?! How to Write and Read Documentation That Allows You To Get Sh*t Done!