Re: Code Annotation of the Week

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.

Scott

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

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-

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.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Code Annotation of the Week: From: Janice Gelb
Re: Code Annotation of the Week: From: quills
Re: Code Annotation of the Week: From: Robert Lauriston

Previous by Author: Re: Code Annotation of the Week
Next by Author: Re: Code Annotation of the Week
Previous by Thread: Re: Code Annotation of the Week
Next by Thread: Re: Code Annotation of the Week


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

Sponsored Ads


Sponsored Ads