Re:Diátaxis
by conradludgate on Saturday August 01, 2026 @04:50PM
(#49138357)
I never saw the point in Diataxis, but honestly while vibe coding it's pretty convenient to tell an LLM "do diataxis" and get decent first pass documentation out of it.
[ Parent
| on HN ]
I found it helpful in thinking about code and the approach for my current project:
https://github.com/WillAdams/gcodepreview
In particular, it made it seem obvious to split up the documentation between:
- Overview --- readme.md
- Tutorials --- handled in various template files
- How to Guides --- embedded in the Literate Program code
- Reference --- the indices and Command Glossary
Ive been aware of diataxis for a while, but i hadnt considered such an approach. Will definitely keep it in mind for when im ready to generate some sort of docs. Thanks!
Re:Diátaxis
by radicalriddler on Saturday August 01, 2026 @05:22PM
(#49138630)
Agreed, a couple months back, I got cf to crawl the site and created a block of skills around it for personal use.
Re:Diátaxis
by c0rruptbytes on Saturday August 01, 2026 @04:59PM
(#49138425)
same, it’s great for first pass LLM docs
Re:Diátaxis
by amazingman on Saturday August 01, 2026 @08:58PM
(#49140069)
You clearly do see the point!
Re:Diátaxis
by conradludgate on Sunday August 02, 2026 @12:09PM
(#49145812)
I used past tense for a reason ;)
Re:Diátaxis
by amazingman on Sunday August 02, 2026 @12:48PM
(#49146104)
Ah, fair! English can be so precise and yet still ... not quite :)