Creating a Documentation Kit

Subject: Creating a Documentation Kit
From: "Cara O Sullivan" <cara_osullivan -at- modusmedia -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 18 Oct 2001 10:36:09 -0600

Dear TechWhirl List:

Hi folks. I'd appreciate input on aan idea I have for a rather complex
documentation situation. I work for a global fulfillment and shipping
company that has over 20 plants around the world, and about 3,200
employees.We have a few hundred IT employees involved in Help Desk, front-
and back-office IT systems management and even software development.

I am the only documentation writer in all of this. As you can imagine, our
process and IT documentation requirements are enormous. And you also know
that documentation can help enforce IT standards. Well, we've got a huge IT
implementation project at the moment that involves lots of testing and
documenting.

To meet the need, 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.

Has anyone on this list ever done anything similar to this? If so, what
pitfalls should I avoid? And is there anything else I could include in the
kit to make it more effective? This kit will be used by people who know lots
about their jobs--some will be good writers and most probably won't be. They
will also be people who don't want to be writing. I've tried to design this
kit with that in mind. This kit really takes the place of a global team of
writers, which is what we should have but simply can't afford in the current
economic environment.

Thanks in advance for any advice you may have.

Cara O'Sullivan, Provo, Utah



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: The saga continues....Acrobat/Word
Next by Author: Thanks for advice on documentation kit
Previous by Thread: RE: Document Management on a Shoestring: Access or HTML or ?
Next by Thread: RE: Creating a Documentation Kit


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

Sponsored Ads


Sponsored Ads