News for hackers. Stuff that matters.

A comment on Diátaxis – A systematic approach to technical documentation authoring. Parent comment

Re:Diátaxis – A systematic approach to technical documentati... by euroderf on Thursday December 05, 2024 @03:59AM (#42326317)
Fair question. I've read a couple of critiques of Diátaxis that suggest additional boxes.

FAQs and "Gotchas" need a "home box". So do gists. Maybe a third dimension would be something like "degree of curation" or "need for taxonomy and organisation" ?

FWIW... DITA has concepts, tasks, & references - and AFAICT these map fairly nicely to Diátaxis.

[ Parent | on HN ]
Re:Diátaxis – A systematic approach to technical documentati... by DanieleProcida on Thursday December 05, 2024 @04:10AM (#42326384)
FAQ lists are the equivalent of the box in my garage where I put things when I've been told to get them out of the house, and I can't actually be bothered to put them in the right place.
[ Parent | on HN ]