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:Business and Technology Requirements documents From:Stuart Burnfield <slb -at- FS -dot- COM -dot- AU> Date:Wed, 23 Apr 1997 14:15:47 +0800
Gaye -
It's just like walking in flippers: the best way to do it is backwards.
What minimum of information is needed in the 'Define & Design' documents
for everyone on the team to get started on their jobs?
- QA people to draft a test plan
- marketing people to draft marketing lit.
- tech writers to write an information plan
- engineers/developers to produce detailed specs or prototypes
If your starting point is "what's supposed to be in a requirements
document?", you're likely to end up with fluff -- how great the product
is going to be, some interesting facts about the product, whose idea it
was, how we intend to optimise the sorting algorithm, etc.
A more practical approach is to start with the stakeholders --
"The 'CamelCaps! Pro for Windows 95 Lite' Requirements Document will be
ready on 30 April. You have to deliver a draft documentation plan on 7
May. What information do you need there to be in the requirements docs?"
"The 'CamelCaps! Pro for Windows 95 Lite' Requirements Document will be
ready on 30 April. You have to deliver a draft QA plan on 7 May. What
information do you need there to be in the requirements docs?"
And so on. Ideally, it should be possible for people with no prior
involvement in the project to write the specs, QA plan, brochures, etc.,
purely from the final requirements docs.
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html