Software Documentation Procedure
The Software Documentation Procedure defines methods and responsibilities for controlling the revision, approval and distribution of documents used to provide software reference and training materials.
The Software Documentation Procedure applies to all software products and updates released by the company. (8 pages, 1808 words)
Document ideas, comments and concerns for possible investigation. Plan on spending as much time as necessary to answer any questions before releasing the documentation into production.
Software Documentation Responsibilities:
The Document Editor is responsible for reviewing software documentation for grammar, punctuation, understanding, and overall usability.
The Quality Assurance Manager is responsible for ensuring that software documentation meets quality requirements.
The Systems Analyst works with and educates the Technical Writer on the proper use of the software and reviewing all documentation for technical accuracy.
The Technical Writer is responsible for gathering information about the software that explains the use of the software to the target user using help files or manuals, while also maintaining and controlling the documentation produced.
Software Documentation Definitions:
Controlled Document – A document that provides information or direction for performance of work and that is within the scope of this procedure. Characteristics of control include such things as Revision Number (letter), signatures indicating review and approval, and controlled distribution.
Document – Information and its supporting medium. The medium can be paper, magnetic, electronic, optical computer disc, photograph, or sample.
External Document – A document of external origin that provides information or direction for the performance of activities within the scope of this procedure.
Software Documentation Procedure Activities
- Software Assessment
- Software Documentation Production
- Software Documentation Review
- Software Documentation Release
- Software Document Revision
- Software Documentation Procedure and Work Instruction Format
Software Documentation Procedure References
- ISO/EIC 12207:1995-Information Technology-Software Life Cycle Processes
- IEEE/EIA 12207.0-Standard Industry Implementation of International Standard ISO/IEC 12207:1995
Software Documentation Procedure Forms
There are no reviews yet.