cdybedahl: (Default)
cdybedahl ([personal profile] cdybedahl) wrote2005-04-30 12:29 pm

How to write documentation in the style of qmail

1) Write down 90% of all relevant information, one piece of it per line.

2) Randomize the order of the lines.

3) Divide the resulting mess into manpages.

4) Sprinkle with SEE ALSO sections that point at randomly chosen other pages.

5) When somebody complains that the documentation is fucking useless, just state that all the information is in there.

[identity profile] khrister.livejournal.com 2005-04-30 11:28 am (UTC)(link)
When I read stuff like this, I'm grateful that we chose postfix...

Not that postfix is all hugs and puppies, but generally the man pages talk about what they're supposed to, are coherent and in many cases even correct.