13 ms·
When people say documentation, they could mean: - a guide to the system to orient yourself - a reference for the api to look up in - tutorials to teach it -
by unconed 3y ago
When people say documentation, they could mean:
- a guide to the system to orient yourself
- a reference for the api to look up in
- tutorials to teach it
- examples to copy/paste
Each has a different audience and requires a different structure and writing style.
I once spent a project being the lone wolf against my will, writing tons of documentation with diagrams. Didn't matter, if anything it just made the rest feel insecure and look bad. Everyone says they want docs but often they don't, really, because they don't read them when they do exist.
- scubbo 3y agoAmen! https://documentation.divio.com/ https://documentation.divio.com/