TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Hi, there. Desperately need some suggestions....
I am attempting to organize my (MIS) department's project documentation
into some standard format so that I can provide all of the people (not
tech writers, BTW) who are documenting with a "bank" of templates. I
want to provide them with a checklist of documents that will need to be
completed for every new application deployment on our network.
It gets even more complicated-- I want to use the same outline formats
to document our applications that have been created by the developers
here as well as purchased/customized software (I don't want to confuse
them with more than one "documentation package").
So far, I have been trying to formulate a list of documents for each of
the following project phases:
-Concept (including items like Business Case Analysis, Req. for
Proposal)
-Plan (Implementation Strategy, Project Plan, etc)
-Build (System Reference)
-Test (Test Plan)
-Pilot (???)
-Deploy (all Training, Troubleshooting, Installation, Support, User/Help
Guides)
I would appreciate suggestions from anyone who has a list of "standard"
documents that they use to accomplish this feat. I am working from
scratch here-- there are no established standards-- and I'm on a
deadline. Could really use some help.
Thanks,
Amy Papa
Comcast Cellular Communications, Inc.
Technical Writer; MIS Dep't.
papaa -at- comcell -dot- com
