News for hackers. Stuff that matters.
Re:The Opposite of Documentation is Superstition (2020) by ChrisMarshallNY on Sunday December 01, 2024 @04:28PM (#42290853)
They are, indeed, useful.

I usually create full-fat test harnesses[0] for my stuff, as that gives a totally realistic implementation example.

But I think having a well-written README is more likely to be useful.

API/implementation documentation (whether docs or tests), are much more likely to be read, than end-user docs.

[0] https://littlegreenviper.com/testing-harness-vs-unit/

There are no comments on this comment yet.