Re:Making world-class docs takes effort
by simonw on Monday September 06, 2021 @02:57PM
(#28436802)
I love the description here of the "scanner" scripts that run to ensure that everything is documented, and each documentation section includes an example.
I've been using a similar approach for my projects for a few years now and it's worked really well: I call it "Documentation unit tests": https://simonwillison.net/2018/Jul/28/documentation-unit-tes...