Writing Docs
Write for the stranger who is you in 6 months.
▶ the lesson · ~35s · narrated · tap for sound
the intro
Documentation is how software survives its authors. A README answers three questions — what is this, how do I run it, how do I use it — and everything else is comments and decision records. Write for the reader with zero context: that reader is future you.
fun fact ✦
The best documentation habit costs ten minutes: write the decision down while you remember why.
the docs
quick hits about Writing Docs
15-second answers · interviews, tips, trivia & hidden gems
📚 tutorial
README vs comments vs ADRs
🔧 useful
The three-header README
💎 deep
The stranger is you
💎 deep
Show, don’t describe