TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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.comhttp://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-