I’ve picked up a few lessons about writing good documentation.
Make sense to your reader.
- If someone’s new, write a tutorial.
- If they have some experience, give them a how-to.
- If they want to go deep, give them a reference.
Don’t mix these. Each has a purpose. Mixing them makes it harder for everyone.
More here: https://documentation.divio.com