logoalt Hacker News

conradludgateyesterday at 8:50 PM7 repliesview on HN

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.


Replies

WillAdamsyesterday at 11:42 PM

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

i_vtoday at 1:22 AM

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!

nchmyyesterday at 10:52 PM

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!

radicalriddleryesterday at 9:22 PM

Agreed, a couple months back, I got cf to crawl the site and created a block of skills around it for personal use.

c0rruptbytesyesterday at 8:59 PM

same, it’s great for first pass LLM docs

amazingmantoday at 12:58 AM

You clearly do see the point!

keeganpoppentoday at 1:50 AM

[dead]