logoalt Hacker News

ibizaman • today at 1:19 PM • 2 replies • view on HN

Same for me. What helped is the realization that I was trying to cater to everyone in the same document. Now I try to follow the organization outlined in https://diataxis.fr/ I’m still very bad at documentation in general but I’m less dissatisfied when I come back a few months later.


Replies

hxugufjfjf • today at 5:34 PM

I started using diataxis for all my docs a while ago and I've never gone back to any other kind of documentation framework. In addition, all docs that do not follow this framework makes me really sweaty.

chanux • today at 1:30 PM

I had diataxis in mind when I wrote my comment. It's an important and excellent guideline on picking the style based on purpose of the doc.