Re: Bad documentation insanity of the day

Subject: Re: Bad documentation insanity of the day
From: Laura Lemay <lemay -at- lauralemay -dot- com>
To: Chris Borokowski <athloi -at- yahoo -dot- com>
Date: Wed, 28 Nov 2007 12:48:31 -0800


On Nov 28, 2007, at 11:44 AM, Chris Borokowski wrote:
> Read on for the horror... the horror...

There was actual content in that comment. It could have been worse.
It could have been:

/* Sets the frame to the Frame frame */
void SetFrame(Frame frame) { ...

I see comments like that EVERY DAY. sob.

Laura

--
*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^
Laura Lemay Killer of Trees lemay % lne.com lemay % gmail.com
http://www.lauralemay.com http://blog.lauralemay.com
*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.DocToHelp.com/TechwrlList

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

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.


Follow-Ups:

References:
Bad documentation insanity of the day: From: Chris Borokowski

Previous by Author: RE: STC Salary data collection
Next by Author: RE: terminology that swings both ways
Previous by Thread: RE: 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