upvote
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

reply
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!
reply
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!

reply
Agreed, a couple months back, I got cf to crawl the site and created a block of skills around it for personal use.
reply
same, it’s great for first pass LLM docs
reply
You clearly do see the point!
reply
I used past tense for a reason ;)
reply
Ah, fair! English can be so precise and yet still ... not quite :)
reply
[dead]
reply