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.
Subject:Standard Doc Set From:Jim Barrow <vrfour -at- verizon -dot- net> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 24 Jan 2008 08:48:14 -0600 (CST)
Now that my company's latest project is wrapping up, we're looking for
new adventures. That is, upper-management is looking around to
see what software should be built, replatformed. re-engineered, etc. To
that end they've asked my group to detail what a "complete doc set" should
The upper-manager who sent me the email specifically said that he wants
me to 'create a plan that details a complete set of requirement docs,' but since
he's out with the flu, I can only assume that he meant a complete doc set.
I'm fairly sure that there's only one or two documents that can be written for
So I wrote a two-page explanation of what our company *should* do when
embarking on a project (best practices) as well as a detailed explanation of
what I thought a complete doc set sould be. From memory this included the
following (in order):
- Problem Statement
- Solution Set
- Functional Analysis
- Project Plan, etc.
There were 15 documents in my core set, and they went from the Problem Statement
above down to QA, Test Plan and End User Documentation.
My guiding principle was the belief that anyone could walk in off the street, read these
15 documents, and have a complete understanding of why we undertook a project, and
how we went about solving the problem.
>From your lessons learned, is there any one document that you recall being absolutely
necessary in a standard software project doc set?
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-