Bad documentation insanity of the day

Subject: Bad documentation insanity of the day
From: Chris Borokowski <athloi -at- yahoo -dot- com>
To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 28 Nov 2007 11:44:02 -0800 (PST)

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...

Read on for the horror... the horror...
technical writing | consulting | development

Never miss a thing. Make Yahoo your home page.

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.


Previous by Author: A blog post all of you wrote: Technical Writing in Transition
Next by Author: Re: Bad documentation insanity of the day
Previous by Thread: Blurb on 'How to Fix Technical Writing'
Next by Thread: RE: Bad documentation insanity of the day

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

Sponsored Ads