2 ms·
I have yet to see a good long detailed but highly readable guide to writing documentation, especially one that explained how to test it for understandability.
by afarrell 12y ago
I have yet to see a good long detailed but highly readable guide to writing documentation, especially one that explained how to test it for understandability.
- theblueadept 12y agoYou'd think/hope that a guide for that topic would be highly readable.
- afarrell 12y agoI've seen lots of style guides, but most of them act like writing documentation and editing it are the same process. And so they will give advice on what not to do like "eliminate unnecessary words", but none on how to actually begin explaining the structure of a new codebase or an old one.