RE: Code Annotation of the Week

["Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>]

I like Gene's suggestions, and I'd tweak it just a bit. I'd limit my
concern to my own area of responsibility: "Are you all sure you want
this in the customer/user manual."

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 Gene Kim-Eng
Sent: Wednesday, November 11, 2009 10:22 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Code Annotation of the Week

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


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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