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:RE: Requirements documents for documentation From:Rose -dot- Wilcox -at- aps -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 5 May 2004 10:47:48 -0700
Yes, I have written tons of 'em. Call 'em Doc Plans or Content Plans...
sometimes call 'em Requirements when the organization I'm in demands it.
In software lifecycle documentation terms, I think of them as a
combination of requirements and design type of docs. Should contain
such info as: Audience Scope Purpose Tools Constraints/Assumptions
Resources Deliverables (may be done to any level of outlining
appropriate) Milestones/Detailed Time Estimates
Just add info and sections to cover the above content in a way that
makes sense for your organization. Nice if you can get these things
signed off. I write 'em even when they aren't required, at least
informally, 'cause they help me think about the project. I try to get
them looked at or signed off on even when the organization doesn't have
process around documentation. For small projects, I summarize the above
topics in an email and send to the requestor and/or concerned parties.
Rose A. Wilcox
Center for Process Excellence, CHQ 8th Floor
602-250-3195
Rose -dot- Wilcox -at- aps -dot- com
'I haven't processed everything yet. My brain isn't really functioning
on the higher levels. It's pretty much fire bad; tree pretty'
Buffy
Graduation Day part II
"MMS <apsc.com>" made the following annotations.
------------------------------------------------------------------------------
--- NOTICE ---
This message is for the designated recipient only and may contain confidential, privileged or proprietary information. If you have received it in error, please notify the sender immediately and delete the original and any copy or printout. Unintended recipients are prohibited from making any other use of this e-mail. Although we have taken reasonable precautions to ensure no viruses are present in this e-mail, we accept no liability for any loss or damage arising from the use of this e-mail or attachments, or for any delay or errors or omissions in the contents which result from e-mail transmission.
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.
