Comment Comment by dharmab Writing accessible documentation.Most people either write no docs or they write a doc that assumes the reader already knows what the thing is.I write docs that assume you're a new employee and explain the thing in simple, plain English before building up the technical details.Notably, these kind of docs make it easy to handoff maintenance and further development to someone else so you can move on to new projects. parent dharmab 6 years ago
Most people either write no docs or they write a doc that assumes the reader already knows what the thing is.
I write docs that assume you're a new employee and explain the thing in simple, plain English before building up the technical details.
Notably, these kind of docs make it easy to handoff maintenance and further development to someone else so you can move on to new projects.