RE: Checking code (was: Software engineer tech. writers? )

["Martinek, Carla" <CMartinek -at- zebra -dot- com>]

-----Original Message-----
Sandy wrote:
If you do check code this way, what should you do with your results?
I considered passing them on to the programming manager, but did not do
it. I figured as a contractor and "only" a tech writer, it was not a
good idea to stir things up that way.
----------

Ditto on Geoff's comments.  As a writer, I consider it part of my job to
point out any areas that *may* cause problems for the end user.  We
(technical communicators) are user advocates and often see things
differently than an engineer or programmer will.

The best way to approach this situation would be to go to either the
TechPubs/Programming/Engineering manager (whomever you feel is
appropriate) and ask them, 

"I see some areas in the code/product that might cause problems for the
end user.  Would you like me to document these and forward them to you?"


If they say "No," then you have your answer, and you may just want to
keep a list for your own reference.  If they say "Yes," this is your
chance to shine and show them that you do more than just "write the
manual."  It could lead to bigger and better things!  (or extended
contracts, or full-time offers...)

-Carla
Cmartinek-at|zebra*com
 
- CONFIDENTIAL-
This email and any files transmitted with it are confidential, and may also be legally privileged.  If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! 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.