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:SQA Plan question From:"Lucero, Peggy A. NMIMC Contractor" <palucero -at- US -dot- MED -dot- NAVY -dot- MIL> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 13 Nov 2003 16:10:51 -0500
Hello,
I feel fortunate to have found this list!
I've been hired to build out software engineering documentation for NMO http://nmo.med.navy.mil/
I am fairly new to this kind of writing!
I just completed the Software Quality Assurance Plan. It is based on IEEE
730-2002, "IEEE Standard for SQA Plans" as the director of this project has
mandated that all of the engineering docs. I author need to follow the IEEE
compliance model.
This SQA Plan contains this section:
.....
Minimum Documentation Required:
1. Software requirement description (SRD)-
2. Software Design Description (SDD)-
3. Verification and validation plans-
4. Verification results and validation results report-
5. User Documentation-
6. Software configuration management plan (SCMP)
7. Other documentation which may include:
a. Development Process Plan
b. Software Development Standards Description
c. Software engineering methods/procedures/tools
description
d. Software project management plan
e. Maintenance plan
f. Software Safety Plans
g. Software Integration Plan
h. Release notes-new features and how NMO will install
the software-last step before the software is put in place
i. MS project plans for each service
j. Standards documents
k. Technical Style Guide
My boss now wants me to write a template/example of *each of these
documents*. I'm hoping somebody reading this has "been there/done that" and
might be able to direct me to a resource that will provide me some guidance
/samples/examples?
Much Appreciated.
All the Best,
Peggy A Lucero
ATS
NMIMC
Naval Medicine Online
8901 Wisconsin Avenue
Bldg 27
Bethesda, MD 20889
v 301 319-1188
RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or download a trial at: http://www.ehelp.com/techwr-l4
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -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.
