Re: Code Annotation of the Week

Subject: Re: Code Annotation of the Week
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 11 Nov 2009 14:03:28 -0800

The original description here ("The writer ... got in trouble for
putting that in the document. Until she proved that the error message
was actually in the software") implies it was not flagged.

On Wed, Nov 11, 2009 at 1:55 PM, Gene Kim-Eng <techwr -at- genek -dot- com> wrote:
> That would be the point of red-flagging the message in product and documentation
> (and while I didn't mention it specifically, not publishing the final document
> without resolution).  If the development team and product manager all sign off
> on leaving the questionable content in place, so be it, but writers and
> programmers should not be making that decision by themselves.  If that sort of
> thing is happening, there are probably any number of other areas where bad
> choices are being made without proper review that increase the chances that the
> product really will melt into slag.
>
> Gene Kim-Eng
>
>
> ----- Original Message -----
> From: "Robert Lauriston" <robert -at- lauriston -dot- com>
> To: <techwr-l -at- lists -dot- techwr-l -dot- com>
> Sent: Wednesday, November 11, 2009 1:23 PM
> Subject: Re: Code Annotation of the Week
>
>
>> As a manager, I'm responsible for the quality of the work of people
>> who report to me. We're not going to distribute patently inappropriate
>> nonsense such as "pish posh Romana" except in response to a written
>> request from some fool with the authority to insist, and I'm going to
>> cover my department's ass so the fool takes the blame.
>>
>> On Wed, Nov 11, 2009 at 12:58 PM, Leonard C. Porrello
>> <Leonard -dot- Porrello -at- soleratec -dot- com> wrote:
>>> "a major red mark in their annual performance evaluation"? Really?
>>>
>>> Leonard
>>>
>>> -----Original Message-----
>>> From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
>>> [mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
>>> om] On Behalf Of Robert Lauriston
>>> Sent: Wednesday, November 11, 2009 10:10 AM
>>> To: techwr-l -at- lists -dot- techwr-l -dot- com
>>> Subject: Re: Code Annotation of the Week
>>>
>>> If that writer reported to me, letting something like that go out for
>>> review would be a major red mark in their annual performance
>>> evaluation....
>>>
>>>
>>>
>> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>>
>> 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 techwr -at- genek -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/techwr%40genek.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
>>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 robert -at- lauriston -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/robert%40lauriston.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
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:
Re: Code Annotation of the Week: From: Robert Lauriston
Re: Code Annotation of the Week: From: Keith Hood
Re: Code Annotation of the Week: From: Robert Lauriston
RE: Code Annotation of the Week: From: Leonard C. Porrello
Re: Code Annotation of the Week: From: Robert Lauriston
Re: Code Annotation of the Week: From: Gene Kim-Eng

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