RE: Bad documentation insanity of the day

Subject: RE: Bad documentation insanity of the day
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 28 Nov 2007 15:09:36 -0500

Great reference! One of the comments included this gem:

"A missing handrail is safer than a rickety one, because if there's no
handrail you keep away from the edge."

It's a fine metaphor for Bertrand Meyer's maxim: "Incorrect
documentation is often worse than no documentation."

> -----Original Message-----
> From: Chris Borokowski
> Sent: Wednesday, November 28, 2007 2:44 PM
> To: techwr-l
> Subject: Bad documentation insanity of the day
> When Andy G opened up libsymblogy.h (sic), he was relieved.
> Finally, some documentation! Of course, upon further
> inspection, Andy realized that the comments didn't quite
> explain how the code works, how it interfaces with other
> modules, or even why it uses certain magic numbers like -13.
> Instead, every function had a comment just as hyperverbose
> and vapid as this...

This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Bad documentation insanity of the day: From: Chris Borokowski

Previous by Author: RE: Word problem
Next by Author: Upgrading Acrobat without messing up Word
Previous by Thread: Bad documentation insanity of the day
Next by Thread: Re: Bad documentation insanity of the day

What this post helpful? Share it with friends and colleagues:

Sponsored Ads