Re: Code Annotation of the Week

Subject: Re: Code Annotation of the Week
From: voxwoman <voxwoman -at- gmail -dot- com>
To: John Posada <jposada99 -at- gmail -dot- com>
Date: Wed, 11 Nov 2009 08:54:40 -0500

Unless she was trying to alert people outside the programming department
about something that could be potentially embarrassing to the company down
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
spelling errors in the UI and messages, but many times, the programmers
"didn't have the time" to fix these things.

-Wendy

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
> Senior Technical Writer
> NYMetro STC President
>
> Looking for the next gig.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 voxwoman -at- gmail -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/voxwoman%40gmail.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:
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

Previous by Author: Re: tifs at 240 dpi worth redoing?
Next by Author: Re: Flash gurus?
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