What nobody tells you about documentation

Why HN readers recommended it

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

This is a summary from the source dataset, not an endorsement by Hacker News or the video creator.

Video & recommendation details

Creator / channel

PyCon AU

Topic

technical documentation

Format

talk

Level

intro

HN recommenders in dataset

3

HN mentions in dataset

6

Recommendation years in dataset

2021–2024

These counts and years describe the included Hacker News records; they are not YouTube views or the video’s publication date.

From the original HN conversations

Excerpts from the recorded comments. Follow each source for the full comment and surrounding discussion.

• 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: …

• It's not a book but a website[1] and a talk[2] that explains a good strategy for writing docs, based on four quadrants. [1] [LINK] [2] [VIDEO]

• ____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 …