Re: Code Annotation of the Week

[Robert Lauriston <robert -at- lauriston -dot- com>]

Acceptable approach, though unless I was in charge of the
documentation department I would run that pass the docs manager first,
and make the manager send the email.

On Wed, Nov 11, 2009 at 10:22 AM, Gene Kim-Eng <techwr -at- genek -dot- com> wrote:
> And yet she got into trouble with someone anyway.  She obviously didn't run it
> past all the right people to avoid that.
>
> In a situation like this one, I would document the message, then distribute a
> "red flag" email all the way up to the product/marketing manager level saying,
> "this is an actual user message in the product, are you all sure you want to do
> this in the product AND document it in the customer/user manual?"  If there's a
> bug/issue tracking system in use, I would also enter it there.
>
> If everybody in the product development food chain really thought there was no
> problem with the idea of displaying a message like that to a customer whose
> product has just melted into slag, I woudn't take it onto myself to decide not
> to document it. But I don't think that particular document would ever make it
> into my portfolio of writing samples.
>
> Gene Kim-Eng
>
>
> ----- Original Message -----
> From: <quills -at- airmail -dot- net>
>> 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.
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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