←back to thread

Examples are the best documentation

(rakhim.exotext.com)
401 points Bogdanp | 1 comments | 09 Oct 25 19:34 UTC | HN request time: 0.246s | source
Show context
smokel ◴[10 Oct 25 05:34 UTC] No.45535616[source]▶
The Diátaxis framework [1] provides a nice suggestion of different types of documentation, and when to use them. None of these types is "best", each serves a different purpose.

[1] https://diataxis.fr/

replies(3): >>45536406 #>>45538965 #>>45539617 #
1. zahlman ◴[10 Oct 25 13:44 UTC] No.45538965[source]▶
This really should be at the top. It was almost frustrating seeing how much other discussion there was here before finally finding mention of Diátaxis.

Examples are crucial to documentation, but they aren't — at least in this view — a kind of documentation, so much as a technique for documenting.