SW Software Documentation SW

Software Documentation User Documentation Software Development Documentation

User Documentation

Software Development Documentation

User Documentation Functional Description what the program will do (overview) Install Manual how to install and to configure the program Introductory Manual in simple terms how to get started with the program Reference Manual all the program functions available for the user Easy To Use Documentation i.e. quick reference cards

Functional Description

what the program will do (overview)

Install Manual

how to install and to configure the program

Introductory Manual

in simple terms how to get started with the program

Reference Manual

all the program functions available for the user

Easy To Use Documentation

i.e. quick reference cards

Planning The planning process - prior to writing the user documentation: 1. Identifying the Software Features, usages, GUI 2. Determining the Document Audience Presentation style and level of details 3. Determining the Document Set Software user documentation 4. Determining the Document Usage Modes Instructional mode or reference mode

The planning process - prior to writing the user documentation:

1. Identifying the Software

Features, usages, GUI

2. Determining the Document Audience

Presentation style and level of details

3. Determining the Document Set

Software user documentation

4. Determining the Document Usage Modes

Instructional mode or reference mode

User documentation - software development phases Requirements Analysis Phase. 1. First draft of the user documentation. Design Phase. 2. Documentation draft updated as more software information becomes available. Development Phase. 3. Documentation draft updated as more software information becomes available. Test Phase. 4. Documentation viewed as a test item for the Test phase, in which it is validated. Software Development Phase User Documentation

Basic Components - IEEE Std. 1063 Title Page - document name, version and date, software being described and the organization issuing the software and documentation. Restrictions - for use or copying the documentation or the software. Warranties - list warranties and contractual obligations. Table of Contents List of Illustrations - figures, tables, exhibits. Introduction - audience description, applicability statement, purpose statement, document usage description, related documents, conventions and problem reporting. Body of Document - instructional or reference. Error Conditions - error messages, known software problems, associated error recovery instructions. Appendixes Bibliography Glossary Index

Title Page - document name, version and date, software being described and the organization issuing the software and documentation.

Restrictions - for use or copying the documentation or the software.

Warranties - list warranties and contractual obligations.

Table of Contents

List of Illustrations - figures, tables, exhibits.

Introduction - audience description, applicability statement, purpose statement, document usage description, related documents, conventions and problem reporting.

Body of Document - instructional or reference.

Error Conditions - error messages, known software problems, associated error recovery instructions.

Appendixes

Bibliography

Glossary

Index

Instructional Mode Document Scope scope of material to be discussed. Materials needed to perform user tasks. Preparations actions that must be done before starting the tasks covered in the section. Cautions and Warnings general and specific. Method description of each task, action performed, possible errors, results to expect. Related Information task relationships, notes, limitation or constraints.

Scope

scope of material to be discussed.

Materials

needed to perform user tasks.

Preparations

actions that must be done before starting the tasks covered in the section.

Cautions and Warnings

general and specific.

Method

description of each task, action performed, possible errors, results to expect.

Related Information

task relationships, notes, limitation or constraints.

Reference Mode Document Purpose Materials - needed to use the function. Preparations - actions done prior to use the function. Inputs - all data required for the correct processing of the function. Cautions and Warnings - general and specific. Invocation - required parameters, optional parameters, default options, order and syntax. Suspension of Operations - interrupt function. Termination of Operations - recognize function termination . Outputs - screen displays, effect on files and data, completion status values or output parameters, outputs that trigger other options.

Purpose

Materials - needed to use the function.

Preparations - actions done prior to use the function.

Inputs - all data required for the correct processing of the function.

Cautions and Warnings - general and specific.

Invocation - required parameters, optional parameters, default options, order and syntax.

Suspension of Operations - interrupt function.

Termination of Operations - recognize function termination .

Outputs - screen displays, effect on files and data, completion status values or output parameters, outputs that trigger other options.

Documentation Team PM Development TL QA Lead Documentation QA Manager PM PM Development Manager Documentation Manager Medium Large

Software Development Documentation

SDD Software Design Description SPMP Software Project Management Plan SRR Software Review Report SRS Software Requirements Specifications SSP Software Safety Plan SVVP Software Verification and Validation Plan SVVR Software Verification and Validation Report TCS Test Case Specification TDS Test Design Specification TIR Test Incident Report TITR Test Item Transmittal Report TL Test Log TP Test Plan TPS Test Procedure Specification TSR Test Summary Report PHAR Preliminary Hazard Analysis Report DI/R User Documentation Instructional/Reference

Software Documentation Flow SSP SPMP PHAR SVVP SRS SDD Code SRR SRR SRR TP TDS TPS TCS TL TSP SVVR TIR TITR DI/R