RE: Code Annotation of the Week

Subject: RE: Code Annotation of the Week
From: "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>
To: "John Posada" <jposada99 -at- gmail -dot- com>, "voxwoman" <voxwoman -at- gmail -dot- com>
Date: Wed, 11 Nov 2009 12:20:21 -0800

Yes, and I'd add that some battles are not worth fighting to the death.

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 John Posada
Sent: Wednesday, November 11, 2009 6:10 AM
To: voxwoman
Cc: TECHWR-L
Subject: Re: Code Annotation of the Week

> Unless she was trying to alert people outside the programming
department
> about something that could be potentially embarrassing to the company
down

Documenting it in customer-facing documnentation is not the way to
avoid embarrassing the company.

> the road. In almost all the places I've worked, the documentation
department
> could not require programmers to change any code. We could point out
gross

But the doc department can alert someone who can.

> On Wed, Nov 11, 2009 at 8:49 AM, John Posada <jposada99 -at- gmail -dot- com>
wrote:
>>
>> One of the skills that a professional technical writer brings is to
>> know what not to document. I'd still nail the writer
>>
>> > 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.
>>
>>
>> --
>> John Posada

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

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


References:
Code Annotation of the Week: From: Janice Gelb
Re: Code Annotation of the Week: From: quills
Re: Code Annotation of the Week: From: John Posada
Re: Code Annotation of the Week: From: voxwoman
Re: Code Annotation of the Week: From: John Posada

Previous by Author: Re: Twitter
Next by Author: RE: Code Annotation of the Week
Previous by Thread: RE: Code Annotation in HTML pages
Next by Thread: Re: Code Annotation of the Week


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


Sponsored Ads