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.
> I want to know if there is anyone on this mailing list who has done
> documentation for Software Quality Assurance Departments.
>
> If yes, can you kindly guide me how to go about preparing a Software
> Project Development Plan.
Hi, Saravanan. I've done a lot of QA documentation and other business
process documentation... I spend at least half my working hours doing
this sort of thing these days.
Unless you are the Subject Matter Expert within your company on
Software QA, somebody else (namely, the QA SME) should be offering you
a great deal of guidance about how your company does software project
development and what needs to be documented according to the quality
and process models that your company uses.
If you've basically been thrown into the deep end and told to write
Project Development documentation without any process guidance, you're
going to have a tough time of it. You are going to need to document
your development process from initial scope definition and
requirements gathering all the way through to delivery and
maintenance, and document the various quality control measures in use
throughout the process. Done correctly, this is a massive job and
will require a great deal of outside input and participation from
members of your development, project management and QA teams, at
minimum.
I wish that I could share a template with you, but the templates and
practices that my company uses are proprietary (this is often the
case, which is why you may not have received much help when you
inquired earlier.) You mention IEEE "guidelines", by which I assume
you mean "standards"... there are *many* IEEE standards that could
apply to the various phases of the development and testing process.
Do you know which standards you must comply with, and do you have
copies?
One international standard for process documentation that is gaining
increasing respect is CMMI, which you can read about here:
If you were to download a CMMI model (say, the Software Model) and
read it, you would get an excellent overview of the kinds of things
you need to document. It's a lot of reading to get through, fair
warning:
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
---
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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
