RE: Creating a Documentation Kit

Subject: RE: Creating a Documentation Kit
From: "Susan W. Gallagher" <SGallagher -at- akonix -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 18 Oct 2001 10:40:24 -0700

Cara,

Sounds good so far. The only thing I'd recommend adding to the kit is a
generic outline. Think about whether the information they're developing will
fit into some sort of standard information flow, then provide the people
who'll be writing the docs with a roadmap. One of the worst things you can
do is hand a non-writer a blank piece of paper and tell them to "go to it"!
;-)

Pitfalls? There'll be lots. People won't follow your instructions, won't
understand how to use the template, ... You'll give training sessions and
nobody will come, then you'll be up till the wee-smalls deleting hard
returns, quotation marks, and parentheses. ;-)

Sometimes, the only way to accomplish a job is to collect what others have
written, even though we'd rather write it all ourselves. Good luck!

HTH
-Sue Gallagher
sgallagher -at- akonix -dot- com


> -----Original Message-----
> ...I've proposed the idea of a documentation kit that
> contains a MS Word template (this is an internal standards);
> a how-to guide;
> and a pre-formatted Excel project spreadsheet that will help
> team leads
> plan and track the progress of their documentation. I'll be
> available to
> help plan the projects, review drafts and provide editing support. The
> managers involved with this project are very enthusiastic
> about the kit and
> getting their people trained on it.

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


Follow-Ups:

Previous by Author: RE: Text Boxes and TOC's in Word
Next by Author: RE: Documentalist?
Previous by Thread: RE: Creating a Documentation Kit
Next by Thread: RE: Creating a Documentation Kit (Long Response)


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

Sponsored Ads


Sponsored Ads