HackerTubewatch
Surprise me
Frame from What nobody tells you about documentation Plays via YouTube's privacy-enhanced embed

What nobody tells you about documentation

PyCon AU
Talks
YouTube
3 HN users recommended this talk3 months2021–2024 score 3.5
Years with an HN recommendation, 2007–2026

HN recommends it as the best concise introduction to a practical framework for structuring documentation, the basis of what became Diataxis.

Daniele Procida's PyCon AU 2017 talk presents a system that divides documentation into four kinds, usually drawn as four quadrants. He explains why mixing them makes docs poor and how separating them improves writing.

“I highly recommend Daniele Procida's talk about this” (HN, 2021)

1 strong recommendations · 3 recommendations · 1 citations · 1 critical · Talks · intro

6 Hacker News comments

From the HN archive; up to 20 kept per video, favoring different commenters. Recommendations first.

@MaxBarraclough Mar 2021 Strongly recommends
on HN thread The tree-based approach to organizing documentation sucks
Read more
Related to this: understanding the various types of documentation, and using them all appropriately. I highly recommend Daniele Procida's talk about this, [0] and the accompanying web page [1]. He gives a useful taxonomy of the 4 kinds of documentation. Through the power of Unicode: ┌──────────────────────────┬─────────────────────────┐ /\ │ Tutorials │ How-to Guide │ || Practical │ (Learning-oriented) │ (Problem-oriented) │ || ├──────────────────────────┼─────────────────────────┤ │ Discussions │ Reference │ || │ (Understanding-oriented) │ (Information-oriented) │ || Theoretical └──────────────────────────┴─────────────────────────┘ \/ <=== Useful for study Useful for coding ===> [0] [this video] (that will take you to the start of the talk proper) [1] [link] edit Didn't spot the link to [1] at the bottom of the article :P
Taxonomy of four kinds of documentation
@O__________O Jun 2022 Recommends
on HN thread How to avoid being a secretary for engineers (2018)
Read more
____Response to Article____ Engineers are rarely good at writing technical documentation, especially compared to technical writers (that is “secretaries” per author’s lingo) which by definition, should be. Engineers generally cost more than technical writers. Good technical writing saves engineering time both during AND after the documentation is produced. Author spends large amount of time, to poorly express that to be a good technical writer, you must understand who needs what and why, then figure out how to solve that the best way based on the context. ____System for to Producing Tech Docs____ Anyone looking for a good system of producing documentation should check out: [link] Which has a 30-min presentation: [this video] Prior HN posts on the system are here: [link]
30-minute presentation of a documentation system
@O__________O Jun 2022 Recommends
on HN thread Ask HN: How to level up your technical writing?
To be a good technical writer, you must understand who needs what and why, then figure out how to solve that the best way based on the context. Anyone looking for a good system of producing documentation should check out: [link] Which has a 30-min presentation: [this video] Prior HN posts on the system are here: [link]
30-minute presentation of a documentation system

Citations, criticism and jokes

@O__________O Jun 2022 Cites it
on HN thread Unified theory of documentation systems
They’re officially related. Personally, prefer the link I used since it provides a table of contents and link to this YouTube presentation on the system: [this video]
Presentation on the documentation system
@zahlman Dec 2024 Pushes back
on HN thread Every board game rulebook is awful [pdf]
I'm a little less than impressed by the presentation here. The idea that Divio is describing here is the Diataxis framework ( [link] ), which "is the work of" ( [link] ) Daniele Procida ( [link] ). Who, incidentally, is also giving the PyCon talk in the video on the page you linked ( [this video] ). But I don't see anything resembling attribution for the ideas. They aren't just common industry knowledge or "received wisdom". (And the "quote" from David Laing at the top isn't really accomplishing anything, either.)

Video list and Hacker News comment labels from HackerTube (prompted by @karpathy), released under ODC-By 1.0, built on the open-index/hacker-news archive. Hacker News data is provided by Y Combinator; comments remain the work of their authors. Video titles, channel names and thumbnails belong to their creators and are shown via YouTube. HackerTube Watch is an unofficial edition. Data export of 2026-10-31.

Keyboard shortcuts

/
Search
j k
Next / previous video
r
Surprise me
l
Like (video page)
w
Watch later (video page)
?
This help
Esc
Close