RE: Documentation Procedures

Subject: RE: Documentation Procedures
From: "Metzger, Lucinda" <cmetzger -at- dukane -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 30 Oct 2001 11:34:51 -0600

Kent,

Your points are valid. And indeed, some of this is also addressed in
Hartman's "Starting a Doc Group" book. I only provided a few main topics as
a starting point.

Amazon doesn't allow you to view the TOC for this particular book, but you
can go here to read editorial and customer reviews (sorry for any icky line
breaks):

http://www.amazon.com/exec/obidos/ASIN/0967417902/qid%3D1004462222/ref%3Dsr%
5F11%5F0%5F1/107-4081760-8414909

Cindy
cmetzger -at- dukane -dot- com


-----Original Message-----
From: Christensen, Kent [mailto:lkchris -at- sandia -dot- gov]
Sent: Tuesday, October 30, 2001 11:03 AM
To: TECHWR-L
Subject: re: Documentation Procedures


re: This book touches on all the main things you'll need to consider (e.g.,
choosing tools, creating style guides, scheduling and planning projects, and
building a doc group), then provides a nice resource section at the back for
more detailed information.

This is cool, but it would be kind of sad if this is all there is. And if
it's considered most important, i.e., the "main thing."

I'd offer as answer to the original question--help in setting up a
documentation department--that the first priority is establishing people
relationships ... with customers. Both customers; the SMEs and the ultimate
customers, i.e. users. How will SMEs and writers communicate? Will there
be user testing of draft documentation? Will the group publish FAQs based
on customer response? Stuff like that.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
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: RE: Documentation Procedures
Next by Author: Re: Text Boxes and TOC's in Word
Previous by Thread: re: Documentation Procedures
Next by Thread: "They don't need no stinkin' documentation..."


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

Sponsored Ads


Sponsored Ads