Re: Software Text Incorrect

[Jo Baer <jbaer -at- mailbox1 -dot- tcfbank -dot- com>]

We document the software as it exists, then try to sneak something into the
documentation to show that we the writers are not complete idiots; that would be
someone else.

Actually, we rarely have this problem with software written in-house; it's the
vendor software that we use that has to be used as-is. As tech writers, we are
not only allowed, but encouraged to point out mis-spellings. Well, there was one
project I worked on where I was told that pointing out errors of any kind
(including how the stupid thing worked) was not my job, but there's a whole set
of stories that goes with that experience.

Jo

--
Jo Baer
Senior Technical Writer
TCF National Bank
Minneapolis, Minnesota
jbaer -at- mailbox1 -dot- tcfbank -dot- com


Weakness Through Strength

Fanatics may defend a point of view
so strongly as to prove it can't be true.

                       Piet Hein


TDean -at- envirosys -dot- com wrote:

> If there is a misspelled word (of course this could apply to crazy
> programmer abbreviations) on the software screen, would you show the field
> name or term in your documentation the way it is represented in the
> software?




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Be a published author!  iUniverse gives you: a high-quality paperback, a
custom cover design, and distribution to 25,00 retailers.  Join our almost
10,000 published authors today. http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
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.