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: Code Annotation of the Week From:quills -at- airmail -dot- net To:Robert Lauriston <robert -at- lauriston -dot- com> Date:Tue, 10 Nov 2009 22:33:58 -0600
It was a proper error message linked to an error code. That the error
would not appear because the machine would have melted into slag first
was irrelevant. She would have gotten into more trouble not documenting
the error message. As it was, she did talk first to the programmer, who
didn't see a problem, and then to his first line supervisor, who
like-wise didn't see a problem.
Damned if you do, damned if you don't.
Robert Lauriston wrote:
> Seems like the writer should still have gotten in trouble for a lack
> of judgment.
> On Tue, Nov 10, 2009 at 7:14 PM, <quills -at- airmail -dot- net> wrote:
>> I'll see yours and raise with this error message.
>> "Pish posh Romana, what could possibly go wrong?"
>> The writer who was documenting the software, got in trouble for putting
>> that in the document. Until she proved that the error message was
>> actually in the software.
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Help and Manual 5: The all-in-one help authoring tool. Full support for
team authoring with multi-user editing - both directly and in combination
with VSS-compatible source control systems. http://www.helpandmanual.com/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-