Hacker News new | ask | show | jobs
by conradludgate 7 hours ago
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.
6 comments

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

With tutorials, I’ve been enjoying handing my agent a directory of screenshots, talking out the process, then having it organize it all into a guide.

Huge fan of Diataxis over the years!

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!
Agreed, a couple months back, I got cf to crawl the site and created a block of skills around it for personal use.
same, it’s great for first pass LLM docs
You clearly do see the point!