Re: Tech Writer "Blurb"

[Barb Ostapina <Barb -dot- Ostapina -at- METROMAIL -dot- COM>]

Gina Hertel asked for thoughts about her tech writer "blurb." I don't
profess to be an expert on this, and my situation as the entire tech comm
department (and a fairly new one at that) for my employer may color my
views, but for what it's worth here are some of my thougths...





<<The Technical Writer will be responsible for interviewing SMEs (subject
matter experts) and conducting QA testing for the product.>>

In case what you write actually gets implemented (vs. remains as good
theory on paper), I would suggest you start the tech writer's involvement
much earlier in the software product development process. Being involved in
the product requirements and specifications meetings (and being the one to
commit them to paper) has made the job of documenting the product later
infinitely easier for me. I don't have to bother SMEs (and supposed SMEs)
as much because I understand what was supposed to happen in the software.

I've had the task of QA testing for a product (even though we have a QA
department -- they were busy), and from my perspective I sure wouldn't want
that to be a part of my job description. Even though I was good at it. For
me, it was like continuously maintaining a document and never getting to
write something new. Having said all that, however, I think a tech writer
can add a lot to the development of the test plan.


<< Using the software itself, client specifications, and any user and
engineer
requirements as a guide, the Technical Writer will also be responsible
for creating and/or contributing to the creation of on-line help files
and user manuals. >>

And maybe other types of online documentation, and other supporting
documentation.
For example, in addition to user guides, I also write technical overviews
that are
sent out (almost as a marketing piece, but with a technical flavor),
"getting
started" type documents (a short, sort of "read me first" that includes
stuff from
the manual that users probably won't read there but that I want them to
see),
record layouts, etc. And, most importantly IMHO, an implementation
procedure
(e.g., how does the product order come in, what is shipped to the customer,
who ships it, how is support handled, etc.). That makes the rollout of the
new
much smoother (usually because it makes people think of things they hadn't
thought of before; of course, that sometimes makes you not so popular,
especially
if what you make them think of sounds like trouble!).


<<If training is involved, the Technical Writer will
work with our Certified Instructors to develop customized courseware for
the new applications.>>

I hope you're referring to more than one tech writer here. This sounds like
a lot to ask of one person.



It's a good start. Hope I've helped. Good luck.
--B
barb -dot- ostapina -at- metromail -dot- com