I and my team did a full set of documentation for handing over a codebase to the client. A large complex codebase with accumulated history and subtle reasons why things were done.<p>Diataxis was <i>fantastic</i>. It took a bit of effort to work out what the page titles were to cover everything we needed, but then when you were writing a page it was glorious.<p>It was so clear what you were saying and what "voice" you were writing in. If it's a Reference page you're all descriptive, with diagrams and bullet points. When it's a guide you're more discursive, but you know you're just imparting information not trying to teach. It made it so much easier to be coherent and clear about everything.
I'd like to take advantage of the attention it's getting to point out that I am working on translating Diátaxis into other languages <a href="https://diataxis.fr/translation/" rel="nofollow">https://diataxis.fr/translation/</a>, and you can see an in-progress version with some partially completed translations at <a href="https://diataxis-translated.readthedocs.io/translation/" rel="nofollow">https://diataxis-translated.readthedocs.io/translation/</a>.
I urge people to not read this. Once you do, you will see all documentation will as the flawed and confusing mess it is. Ignorance is bliss!
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.
I found it helpful in thinking about code and the approach for my current project:<p><a href="https://github.com/WillAdams/gcodepreview" rel="nofollow">https://github.com/WillAdams/gcodepreview</a><p>In particular, it made it seem obvious to split up the documentation between:<p>- Overview --- readme.md<p>- Tutorials --- handled in various template files<p>- How to Guides --- embedded in the Literate Program code<p>- 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!
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.<p>Huge fan of Diataxis over the years!
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 <i>do</i> see the point!
[dead]
Posted many times. Here's the most recent time from 2024 (also has most discussion).<p><a href="https://news.ycombinator.com/item?id=42325011">https://news.ycombinator.com/item?id=42325011</a>
We just invested a good amount of time restructuring our docs for Diátaxis. It was helpful, but I wouldn't take it as gospel. The important thing to remember is that each piece of content should be one of the four types.<p>If you're embarking upon a refactoring / rewriting journey for your docs, the only advice I'd share is to actually read the website beginning to end before starting. Especially this page: <a href="https://diataxis.fr/complex-hierarchies/" rel="nofollow">https://diataxis.fr/complex-hierarchies/</a>. The guide is (unsurprisingly) very well written, and it's easy to internalize the concepts because they're repeated often.
Ugh, I don't like that page and I have actually deleted it. It'll be gone soon.<p>There is a real problem there, and that page doesn't do a good enough job of dealing with it. I have something cooking that is much, much better.
We're currently in the process of restructuring our documentation and I'd be very interested in an early draft of this, fully understanding that caveat emptor. Is it published anywhere currently?
Please post some kind of visible change notification (and something here) when you do!
It makes sense to me (I agree with it), but I also agree that it doesn't really deal with it. I look forward to whatever you're cooking!
Here you go, made a skill for it: <a href="https://github.com/peterknego/diataxis-docs-skill" rel="nofollow">https://github.com/peterknego/diataxis-docs-skill</a><p>Just released, alpha quality, need feedback/fine-tuning. Testing it now on my OSS repos.
How is this different from Divio's documentation system?:
<a href="https://docs.divio.com/documentation-system/" rel="nofollow">https://docs.divio.com/documentation-system/</a><p>Update: <a href="https://diataxis.fr/colophon/#origins-and-development" rel="nofollow">https://diataxis.fr/colophon/#origins-and-development</a> (Divio came first).
I love whenever this comes up. It’s a great framework for thinking about and writing docs.<p>It’s hard to keep documentation up to date, however, and I find that items like tutorials and reference materials (unless generated off versioned code) can drift pretty far over time.<p>A feature I like in concept that notion introduced with wikis ages ago was a “verification” timestamp, where you specify a timeframe after which the doc owner has to reconfirm that the doc is up to date. A bit too easy to rubber stamp, unfortunately, but maybe if it took the doc offline entirely without a more robust audit.
I am sure that this exists for other ecosystems as well - rustdoc, Documenter.jl and Sphinx seem to support this - but my experience lies in R: three of the Diátaxis categories map quite nicely onto R package constructs:<p>- Tutorials are implemented as "vignettes", executed on package validation
- How-Tos are attached in roxygen documentation chunks, likewise executable by default - execution disabled when expensive or to avoid side effects.
- Reference is implemented in a TeX or Markdown format, commonly parsed by roxygen<p>The only thing that's missing is a canonical way of documenting implementation rationale. Having the documentation outside the repo worked before LLMs, but there was always that weak point of code drifting away from the documentation...
I can't help but notice that for a documentation organization framework/method it failed to produce its own good documentation.<p>There are repetitive bloated texts with unnecessary distractions and unenlightening illustrations. It is maybe well-organized, if one can speak about good organization of poorly expressed knowledge at all.
The concept of 4 different uses of documentation seems great. But I wonder why the presentation of Diaraxis itself is not clearly structured into these 4 different "views" on documentation? Or are they?
I also admire what there isn't: certs, training, manifesto, "yah ain't holding it rite" blog posts, and job ads for a "Diátaxis Master".
Hypotaxis: arranging under<p>Parataxis: arranging alongside<p>Diátaxis: arranging across
I was not familiar with Diataxis, and as I was reading through the webpage, I kept wondering if there were any concrete examples. I love cooking, and it was interesting to see that some of the insights of the whole philosophy used teaching how to cook as an example.<p>I read a lot of cookbooks, and interestingly enough, I never stopped thinking about what makes a good cookbook (except for its recipes). Diataxis answers that in a way. Indeed, the best cookbooks I have read in some way or another followed Diataxis.
Perhaps add <i>"A systematic approach to technical documentation authoring"</i> to the title?
I love seeing this pop up again. Our customer support team has been steadily moving all of our docs over to Diátaxis for a while and it's been a really nice improvement.
Please do not make me click on "reference" to get to "API docs". I love diataxis, but dear lord, do not make me click an extra time to get to the thing I actually need 95% of the time.<p>Overall, the movement is good, except for how it tends to turn 1-click docs into 2-click docs (or more for folks who don't know that API docs probably live under reference.)<p>You are allowed to have a top level tab/link to API docs. Please do not hide those from me while you "improve" your docs.
I'm genuinely confused about what one would expect under "reference" that isn't effectively API-shaped (in the context of software). Like, I've never consciously thought of this before but I can't remember a time that they haven't effectively been synonyms in my mind when I'm navigatig documentation.
That's part of the problem. Some projects, when they move to diataxis, will create a top level section called "reference" and have a single item under it called "API" (or similar.)<p>Depending on the docs theme, it can require clicking through to get to it.<p>It is a minor annoyance.<p>edit: Also gonna tack onto this that my original comment reads way more acerbic than I actually feel. I was sleepy and didn't proofread for tone like I normally do.
Another documentation model: Fabrizio's seven actions [0]. People read docs to appraise, understand, explore, practice, remember, develop, and troubleshoot, usually in that order.<p>It feels so natural and obvious compared to Diataxis' forced abstractions, where I'm still left wondering "what's the difference between a tutorial and a how-to guide?"<p>But! I'm glad for anything that helps people organize and maintain docs.<p>[0] <a href="https://passo.uno/seven-action-model/" rel="nofollow">https://passo.uno/seven-action-model/</a>
> ...where I'm still left wondering "what's the difference between a tutorial and a how-to guide?"<p>I don't find this question difficult. Without looking anything up, a tutorial exercises a contrived example for learning purposes, whereas a how-to guide provides instructions suitable for real world execution.
How to guide is for things which you want to do, probably not without going in depth or understanding the technicalities.<p>Example in our codebase<p>- How to clear the cache ?<p>- How to configure the logger ?<p>I liked the idea of separating our how to guides and explanations / tutorials, because sometimes you just want engineers to follow a specific flow without going too much in depth.
Diataxis + ADRs + C4 = The holy trinity of docs
C4[1]? Hadn’t heard of it until now. Thanks!<p>Really curious what the major differences are that have you preferring it over other methods / winging it.<p>[1]: <a href="https://c4model.com/" rel="nofollow">https://c4model.com/</a>
I had to search these terms, does ADR mean ‘Architecture decision record’ and C4 the ‘C4 model’? How do you combine them in documentation?
I’ve been loving Diataxis! My agents follow guidance that links from other file types to a reference file type must be one way. Stays DRY. Also to regularly cut long reference files into smaller focused ones and link from the main.<p><pre><code> tutorial/setup-buh-snuh-env.md
how-to/configure-buh.md
install-snuh.md
reference/buh.md
snuh.md
snuh-licenses.md
explanation/why-we-use-buh.md</code></pre>
I've also found these guidelines helpful:<p>1. In general, do whatever Wikipedia does. e.g., start with a one-sentence definition, then a couple paragraphs of summary, then go into short specified sections, and keep links to the "Citations" at the end. It's been refined for 25 years, it's older than most of your engineers, it's 50+% correct by default.<p>2. Keep every section to one screenful. If your reader can't see a headline, they get lost.<p>3. Put a funny picture at the top of the page. Or at least something off Wikimedia Commons.<p>4. Don't spend a lot of time writing anything. And don't use AI. The AI doesn't know what's inside your head. You yourself have an inkling. The longer you write, the further you'll get. Just write one short thing at a time and refactor aggressively later. Never throw shit over a fence blind. Nobody reads shit that's been flung over a fence.<p>Steven King said writing is telepathy. All mediated communication sits on a Pareto trade-off with face-to-face communication. Media is always less interactive with slower iterations. You need to figure out exactly what your audience needs, right when they're reading, and write just that, knock 'em dead, and leave. Don't add detail. They'll ask if they need detail.
I don't have a problem with Diataxis itself but every time it comes up it saddens me because it is a reminder of how bad the technical writing community (by which, here I mean people who have technical writer as a job title) has been about popularizing and sharing their institutional knowledge, to the point that diataxis is far more popular and what a lot of people in tech think about when they think about technical writing.
The old (now legacy) apple documentation roughly seemed to follow this pattern I think.
[flagged]
[flagged]