Treating documentation like an interface, not a manual As of late, I’ve reviewed documentation less as “instructions” and more like an interface. ~
Users find it hard to use documentation just as they find it hard to use a product with a bad interface.
It changed the way I write, for example: Headings are like boundaries to an API. I prioritize example before explanation. If it lowers cognitive load, repetition is warranted. I made the following changes: Even if it may feel like it has been too short, I hope you will not mind the sections. Even better, try to remove everything except for one idea per page.
Try not to write for the expert, write for the most confused reader. I’ll ask you the following: Do you see docs as some sort of ux too? How do you test docs, without watching someone live?
Not everything is for everyone. The page is the equivalent to a printed manual with a loc.
The thing is, documentation isn't a monolithic thing --- it really needs to be sub-divided/categorized into subsets which are useful to specific categories of folks working on, or working with, a project:
https://diataxis.fr/
(originally developed at: https://docs.divio.com/documentation-system/)