3 ms·
The Documentation System
- zknill 3y agoI regularly share this with teams that I work with. I think it's the clearest explanation of how to write docs that I've seen. I see "explanation" and "how-to" conflated so regularly, as a quickstart how-to guide falls into a tangent of explaining why something works a certain way.
- chuckhend 3y agoAgree. When docs go on a tangent, or try to cover all these in a single doc, I think it's easy for the reader to get lost. Can you recommend any other useful resources?