Software documentation primer presentation - Working Group - IEEE

lumpysteerSoftware and s/w Development

Dec 2, 2013 (3 years and 6 months ago)

87 views


1

09/10/02

WG12 Software Primer

For

RTVIS Committee


September 10, 2002


2

09/10/02

Software Development Cycle



3

09/10/02

Issues



Duplicate information contained in multiple standards


IEEE 730 Quality Assurance


IEEE 830 Requirements Specification


IEEE1016 Design Description



Conflicting customer requirements such as references to
these standards in the same specification:


ATA 102 Software Manual


IEEE J
-
Std
-
016 Software User Manual



4

09/10/02

Issues



Duplicate standards



EIA/IEEE J
-
Std
-
016


EIA/IEEE 12207



These documents contain similar requirements that
are listed in different sections.


Some differences between these standards



12207 finally superceded J
-
Std
-
016



5

09/10/02

Issues



IEEE 12207 combined many requirements
into one document but other documents still
exist or are under active review.



Withdrawn documents


1074.1

Life Cycles (see 12207)


1348

CASE Tools


6

09/10/02

Issues



Active Working Groups


610

Terminology


730.1

Quality Assurance (SQAP)


828

Configuration Management (SCMP)


829

Test Procedures (STPr)


830

Requirements Specification (SRS)


1012

Verification & Validation (SVVP/SVVR)


1016

Design Description (SDD)


1058.1

Project Management Plan (SPMP)



7

09/10/02

Issues



1063 Software User Documents (SUD) issued in 2001



CMM implementation


How do you satisfy the process
needs against the documentation needs



System complexity


separation of hardware and software



End user needs


from planning, through development and
maintenance



8

09/10/02

Issues



Project size


stand alone processors to
large systems using multiple processors



Project implementation


Processors that are treated separately (vehicle
systems)


Multiple processors treated as one (control systems)


9

09/10/02

Actions Taken



Froze the input as of January 1, 2002



Accepted 12207 as the general guideline



Confirmed that documents required are needed to
comply with CMM requirements



System functional requirements
-

not addressed
only address software process




10

09/10/02

Standard Contents



Life cycle model



Document submittals



Documents required



Hard copy format



11

09/10/02

Life Cycle




12

09/10/02

Document Submittal

(based on end user needs)

Type 1


Install and use


Type 2


Planning


Type 3


Requirements and interfaces


Type 4


Testing


Type 5


Complete documents



13

09/10/02

Document Submittal


Document

Abbreviation

Type
1

Type
2

Type
3

Type
4

Type
5

Project Planning and Oversight







Software Project Management
Plan

SPMP


X

X

X

X

Software Quality Assurance Plan

SQAP




X

X

Software Configuration
Ma
nagement Plan

SCMP




X

X

Software Verification and
Validation Plan

SVVP




X

X

Software Verification and
Validation Report

SVVR




X

X








Software Elements







Software Requirements
Specification

SRS



X

X

X

Interface Control Description

ICD



X

X

X

Software Design Description

SDD





X

Database Design Description

DBDD





X

Software Requirements
Traceability Matrix

SRTM



X

X

X

Software Test Plan

STP




X

X

Software Test Procedure

STPr




X

X

Software Test Report

STR



X

X

X








Sof
tware Release







Software Version Description

SVD

X

X

X

X

X

Software User Manual

SUM

X

X

X

X

X



14

09/10/02

Documents Required



Project planning and oversight



Elements


design and testing



Release



Documents required for all projects regardless of
end user needs





15

09/10/02

Project Planning and Oversight



Software Project Management Plan (SPMP)


Software Quality Assurance Plan (SQAP)


Software Configuration Management Plan
(SCMP)


Software Verification and Validation Plan
(SVVP)


Software Verification and Validation Report
(SVVR)


16

09/10/02

Software Elements



Software Requirements Specification (SRS)


Interface Control Document (ICD)
-

optional


Software Design Description (SDD)


Database Design Description (DBDD)
-

optional


Software Requirements Traceability Matrix
(SRTM)



17

09/10/02

Software Elements



Software Test Plan (STP)


Software Test Procedure (STPr)


Software Test Report (STR)


18

09/10/02

Software Release



Software Version Description (SVD)



Software User Manual (SUM)


19

09/10/02

Document Outline



Tabular Form



Column Listing


Section number


Change from reference standard


Content list


Applicability


Comments


20

09/10/02

Column Meaning


Section
-

same for each document


Change


identified if additional, modified or not required from
reference standard


Content


section title


Applicability


mandatory or recommended (optional)


Comment


provides additional information on usage or source



21

09/10/02

Sample Table
-

SQAP


Section

Changes

Content List

Applicability

Comments

Cover

A

Date of issue and
document status

Mandatory

Added to satisfy
12207.1
-
1997

Inside
Cover

A

SQAP Change History

Mandatory

Added to satisfy
12207.1
-
1997

1.0


Purpose

Mandatory


1.1


SQAP Purpose

Mandatory


1.2


Scope

Mandatory


1.3

M

SQA Objectives

Mandatory

Documents
motivating the
SQAP shall be
referenced
-

Added
to satisfy 12207.1
-

1997

1.4


Software Items
Covered

Mandatory

Highest level
aggregate(s) of
software elements
covered by this plan

1.5


SQA Life Cycle

Recommended




22

09/10/02

Sample Table


STP


Section

Changes

Content List

Applicability

Comments

Cover

A

Date of issue and document
status

Mandatory

Added to satisfy requirements of IEEE
12207

Inside
Cover

A

Document Change History

Mandatory

Added to satisfy re
quirements of IEEE
12207

1.0


Test plan identifier

Mandatory


2.0


Introduction

Mandatory


2.1


Objectives

Mandatory


2.2


Background

Not Required


2.3


Scope

Mandatory


2.4


References

Mandatory


3.0


Test items

Mandatory


4.0


Features to be test
ed

Mandatory


5.0


Features not to be tested

Mandatory


6.0


Approach

Mandatory


7.0


Item pass/fail criteria

Mandatory


8.0


Suspension criteria and
resumption requirements

Mandatory


9.0


Test deliverables

Mandatory


10.0


Testing tasks

Mandatory


11.0


Environmental needs

Mandatory


12.0


Responsibilities

Mandatory


13.0


Staffing and training needs

Mandatory


14.0


Schedule

Mandatory


15.0


Risks and contingencies

Mandatory


16.0


Approvals

Mandatory









23

09/10/02

Hard Copy Format


Title sheet


project name, document name,
number and revision


Inside title


revision history


1.0 Purpose

Purpose, scope, objectives, software item covered,
standards and maintenance



24

09/10/02

Hard Copy Format


2.0 References

Documents, abbreviations and definitions


3.0 and higher

Per the requirements for each document


25

09/10/02

Conclusions



Document submittals


customer specified



Documents required


all needed to support
understanding, control and maintenance



Hard copy format


if delivered in that media



CMM


supports the process