on technical writers

Subject: on technical writers
From: "Laura A Mac Lemale" <lmaclemale -at- paychex -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 20 Mar 2002 14:27:40 -0500

Hello,

Chiming in a little late on this due to ever-looming deadlines....

Re: Technical vs. "Writerly" Writers

On the idea that TWs need technical aptitude subordinate to/equal
to/superior to that of the programmer, I believe that the TW should have
a big-picture view of the project/product being written about. The
programmer is the one who has the detailed knowledge of every component
of the project/product.

Yes, we have to understand the how's and why's of the system as well as
the how's and the why's of how the users will use it. And we have to be
able to apply this understanding to the documentation. And we have to
be able to communicate with our SMEs and ask the right questions if our
understanding of the project/product is in question. If our knowledge
is not accurate, it stands to reason that the documentation will not be
accurate.

Re: Tech writing vs. Creative writing

IM(NS)HO, TW should be transparent, with a focus on clarity and
brevity. No one should open a software manual and be moved to tears by
the witty and wonderful prose. <g> While I don't debate the merits of
one over the other,--I enjoy them both--I do see them as two separate
and distinct flavors of writing (and, therefore, two separate and
distinct processes).

Just adding my late 2 American cents!

Regards,
Laura
(whose first writing project for fun was a short story at age 7 or 8,
entitled, "Herman the Sink".....or is that TMI??) <g>

--


--
Laura MacLemale
Technical Writer, EDV
Paychex HRS Operations
(585) 336-6515
lmaclemale -at- paychex -dot- com

Disclaimer: The views expressed in this message represent those of the
sender and not of Paychex, Inc.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at
http://www.ehelp.com/techwr
---
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.



Previous by Author: Techwr-L
Next by Author: Re: Andy Richter deserves to be laid off
Previous by Thread: re: on technical writers
Next by Thread: Re: Some thoughts on knowledge management,-- content management and single sourcing


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

Sponsored Ads


Sponsored Ads