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: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...
____________________________________________________________________________________
Never miss a thing. Make Yahoo your home page. http://www.yahoo.com/r/hs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
