RE: wording for training materials

[rbilbao -at- us -dot- amadeus -dot- net]

Our manager/editor is the most gracious and giving person in the history of
management. She works alongside the writers, gently guiding us toward
consistent, quality documentation. When I don't agree with something I feel
quite free to let her know. We'll usually hash it out and if we're not convinced
we'll research it a little until we find a solution we can both live with. We're
pretty much on the same track so this process usually doesn't take very long.
Regardless, I would never simply ignore one of her edits and submit the doc as
final, and it sounds to me like that's what the writer in question did. At the
very least, he/she could've let the editor know the reasons for not making the
change. I feel that's just common courtesy, company management style not
withstanding.

Recently, I've also been on the other side of the coin, editing for other
writers. I find it difficult, so I respect the work that my editor does for me
and I'm thankful that I have someone who can second-guess me objectively and
help me become a more effective writer. (Oh yeah, and she makes fun of my "comma
obsession", too!)

Anyway, if the doc refers to things the sales support people can and will do, I
would also use "you" and not "the user".
Rhina


Shea Michael EXT <Michael -dot- Shea -dot- extern -at- icn -dot- siemens -dot- de> wrote:
##################
Mr. Margulis ponders...
But in a Theory Y organization, or anywhere that the editor is seen as a
colleague providing a service to the writer, I can't see that a disagreement of
this type constitutes insubordination or any other sort of corporate sin.
##################

This brings up a question or two for me. I have often heard anecdotes about
editors who were nit picky or writers who ignored comments from others.

Do you (the reader) use your editors (when you have them)? That is to say, do
you find them generally useful or do you prefer to do your own editing? Do you
see them as colleagues or as a nuissance?

I have always preferred to work with an editor than without one (Hi Chris! Hi
Nan!). I find that having someone make me justify my decisions, helps me to
produce better documentation.

I bet there is an editor list out there with a monthly discussion of: the
writers are ignoring my edits. What do I do? Kind of like us trying to get
information out of reluctant engineers.

-Michael




**********************************************************************
This email message and information contained in or attached to this message 
may be privileged, confidential, and protected from disclosure and is intended 
only for the person or entity to which it is addressed.  If you are not the 
intended recipient any retransmission, dissemination, printing or other use of,
or taking of any action in reliance upon, this information is strictly prohibited.  
If you received this message in error, please immediately inform the sender by
reply e-mail and delete the message and any attachments.  This footnote also 
confirms  that this email message has been swept by MIMEsweeper for the 
presence of computer viruses. Thank you. 
**********************************************************************



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l

Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade.  Offer ends 10/31/2002 (code: DTH102250).
http://www.componentone.com/d2hlist1002

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit
http://www.raycomm.com/techwhirl/ for more resources and info.