CHAPTER 1 INTRODUCTION

DOCUMENT STATUS SHEET

Approved, 15th May 1992

Board for Software Standardisation and Control C. Mazza, Chairman

Approved, 10th June 1992 Telematics Supervisory Board

Approved by: The Inspector General, ESA

Published by ESA Publications Division, ESTEC, Noordwijk, The Netherlands. Printed in the Netherlands. Price: 35 Dutch Guilders ISSN 0379 - 4059

Copyright © 1992 by European Space Agency

ESA PSS-05-05 Issue 1 (May 1992) iii

TABLE OF CONTENTS

DOCUMENT STATUS SHEET ............................................................................ II

CHAPTER 1 INTRODUCTION ............................................................................ 11.1 PURPOSE ................................................................................................. 1

1.2 OVERVIEW ............................................................................................... 1

CHAPTER 2 THE DETAILED DESIGN AND PRODUCTION PHASE .............. 3

2.1 INTRODUCTION ....................................................................................... 3

2.2 EXAMINATION OF THE ADD ................................................................... 4

2.3 DETAILED DESIGN .................................................................................. 5

2.3.1 Definition of design standards ......................................................... 5

2.3.2 Decomposition orthe software into modules .................................. 6

2.3.3 Reuse of the software ...................................................................... 6

2.3.4 Definition of module processing ...................................................... 7

2.3.5 Defensive design ............................................................................. 8

2.3.6 Optimisation ..................................................................................... 10

2.3.7 Prototyping ....................................................................................... 11

2.3.8 Design reviews ................................................................................. 11

2.3.9 Documentation ................................................................................. 12

2.4 TEST SPECIFICATIONS ........................................................................... 13

2.4.1 Unit test planning ............................................................................. 13

2.4.2 Test designs, test cases and test procedures ................................ 13

2.5 CODING AND UNITTESTING ................................................................. 14

2.5.1 Coding .............................................................................................. 14

2.5.1.1 Module headers ....................................................................... 15

2.5.1.2 Declarations of variables ......................................................... 15

2.5.1.3 Documentation of variables ..................................................... 16

2.5.1.4 Names of variables .................................................................. 16

2.5.1.5 Mixing data types .................................................................... 16

2.5.1.6 Temporary variables ................................................................ 16

2.5.1.7 Parentheses ............................................................................. 17

2.5.1.8 Layout and presentation .......................................................... 17

2.5.1.9 Comments ................................................................................ 17

2.5.1.10 Diagnostic code ..................................................................... 17

2.5.1.11 Structured programming ....................................................... 18

2.5.1.12 Consistent programming ....................................................... 18

2.5.1.13 Module size ............................................................................ 18

2.5.1.14 Code simplicity ...................................................................... 18

2.5.2 Coding standards ............................................................................ 19

2.5.3 Unit testing ....................................................................................... 19

2.6 INTEGRATION AND SYSTEM TESTING .................................................. 20

2.6.1 Integration ........................................................................................ 20

2.6.2 Integration testing ............................................................................ 21

2.6.3 System testing .................................................................................. 21

2.7 PLANNING THE TRANSFER PHASE ....................................................... 22

2.8 THE DETAILED DESIGN PHASE REVIEW ............................................... 22

iv ESA PSS-05-05 Issue 1 (May 1992)

CHAPTER 3 METHODS FOR DETAILED DESIGN AND PRODUCTION ........ 25

3.1 INTRODUCTION ....................................................................................... 25

3.2 DETAILED DESIGN METHODS ................................................................ 25

3.2.1 Flowcharts ........................................................................................ 26

3.2.2 Stepwise refinement ......................................................................... 26

3.2.3 Structured programming .................................................................. 26

3.2.4 Program Design Languages ............................................................ 28

3.2.5 Pseudo-code .................................................................................... 28

3.2.6 Jackson Structured Programming ................................................... 29

3.3 PRODUCTION METHODS ........................................................................ 29

3.3.1 Programming languages ................................................................. 30

3.3.1. T Feature classification ............................................................... 30

3.3.1.1.1 Procedural languages ..................................................... 30

3.3.1.1.2 Object-oriented languages ............................................. 32

3.3.1.1.3 Functional languages ...................'................................... 32

3.3.1.1.4 Logic programming languages ....................................... 33

3.3.1.2 Applications ............................................................................. 34

3.3.1.3 FORTRAN ................................................................................. 34

3.3.1.4 COBOL ..................................................................................... 35

3.3.1.5 Pascal ...................................................................................... 36

3.3.1.6 С ............................................................................................... 36

3.3.1.7 Modula-2 .................................................................................. 37

3.3.1.8 Ada ........................................................................................... 37

3.3.1.9 Smalltalk ................................................................................... 38

3.3.1.10 C++ ........................................................................................ 38

3.3.1.11 LISP........................................................................................ 38

3.3.1.12 ML .......................................................................................... 39

3.3.1.13 Prolog ..................................................................................... 39

3.3.1.14 Summary ................................................................................ 41

3.3.2 Integration methods ......................................................................... 41

3.3.2.1 Function-by-function ................................................................ 42

3.3.2.2 Top-down integration ............................................................... 43

3.3.2.3 Bottom-up integration .............................................................. 43

CHAPTER 4 TOOLS FOR DETAILED DESIGN AND PRODUCTION .............. 45

4.1 INTRODUCTION ....................................................................................... 45

4.2 DETAILED DESIGN .................................................................................. 45

4.2.1 CASE tools ....................................................................................... 45

4.2.2 Configuration managers .................................................................. 46

4.2.3 Precompilers .................................................................................... 46

4.3 PRODUCTION .......................................................................................... 46

4.3.1 CASE tools ....................................................................................... 47

4.3.2 Code generators .............................................................................. 47

4.3.3 Editors .............................................................................................. 47

4.3.4 Language-sensitive editors .............................................................. 48

4.3.5 Static analysers ................................................................................ 48

4.3.6 Compilers ......................................................................................... 49

4.3.7 Linkers .............................................................................................. 50

4.3.8 Debuggers ....................................................................................... 51

4.3.9 Dynamic analysers ........................................................................... 52

4.3.10 Test tools ........................................................................................ 52

4.3.11 Word processors ............................................................................ 53

4.3.12 Documentation generators ............................................................ 54

4.3.13 Configuration managers ................................................................ 54

ESA PSS-05-05 Issue 1 (May 1992) v

CHAPTER 5 THE DETAILED DESIGN DOCUMENT ........................................ 55

5.1 INTRODUCTION ....................................................................................... 55

5.2 STYLE ....................................................................................................... 55

5.2.1 Clarity ............................................................................................... 55

5.2.2 Consistency...................................................................................... 56

5.2.3 Modifiability ...................................................................................... 56

5.3 EVOLUTION ............................................................................................. 57

5.4 RESPONSIBILITY ..................................................................................... 57

5.5 MEDIUM ................................................................................................... 57

5.6 CONTENT ................................................................................................. 57

5.6.1 DDD/PartI -General description ................................................... 59

5.6.1.1 DDD/Partl/1 Introduction ....................................................... 59

5.6.1.1.1 DDD/Part 1/1.1 Purpose (of the document) .................... 59

5.6.1.1.2 DDD/Part 1/1.2 Scope (of the software) ......................... 60

5.6.1.1.3 DDD/Part 1/1.3 Definitions, acronyms & abbreviations .. 60

5.6.1.1.4 DDD/Part 1/1.4 References ............................................. 60

5.6.1.1.5 DDD/Part 1/1.5 Overview (of the document) .................. 60

5.6.1.2 DDD/Part 1/2 Project standards, conventions & procedures .. 60

5.6.1.2.1 DDD/Part 1/2.1 Design standards .................................. 60

5.6.1.2.2 DDD/Part 1/2.2 Documentation standards ..................... 61

5.6.1.2.3 DDD/Part 1/2.3 Naming conventions .............................. 61

5.6.1.2.4 DDD/Part 1/2.4 Programming standards ........................ 61

5.6.1.2.5 DDD/Part 1/2.5 Software development tools .................. 62

5.6.2 DDD/Part 2 - Component design specifications ............................. 63

5.6.2.1 DDD/Part 2/5.n Component Identifier ...................................... 63

5.6.2.1.1 DDD/Part 2/5.П.1 Type .................................................... 64

5.6.2.1.2 DDD/Part 2/5.n.2 Purpose ............................................... 64

5.6.2.1.3 DDD/Part 2/5.П.З Function .............................................. 64

5.6.2.1.4 DDD/Part 2/5.n.4 Subordinates ....................................... 65

5.6.2.1.5 DDD/Part 2/5.n.5 Dependencies ..................................... 65

5.6.2.1.6 DDD/Part 2/5.n.6 Interfaces ............................................ 65

5.6.2.1.7 DDD/Part 2/5.n.7 Resources ........................................... 66

5.6.2.1.8 DDD/Part 2/5.n.8 References .......................................... 66

5.6.2.1.9 DDD/Part 2/5.n.9 Processing .......................................... 66

5.6.2.1.10 DDD/Part 2/5.n.10 Data ................................................. 67

5.6.3 DDD/Appendix A: Source code listings .......................................... 67

5.6.4 DDD/Appendix В: Software requirements traceability matrix ......... 67

CHAPTER 6 THE SOFTWARE USER MANUAL .............................................. 69

6.1 INTRODUCTION ....................................................................................... 69

6.2 STYLE ....................................................................................................... 69

6.2.1 Matching the style to the user characteristics ................................ 70

6.2.1.1 The end user's view ................................................................. 70

6.2.1.2 The operator's view ................................................................. 70

6.2.1.3 The trainee's view .................................................................... 71

6.2.2 Matching the style to the HCI characteristics ................................. 71

6.2.2.1 Command-driven systems ....................................................... 71

6.2.2.2 Menu-driven systems ............................................................... 72

6.2.2.3 Graphical User Interface systems ........................................... 72

6.2.2.4 Natural-language and speech interface systems ................... 73

6.2.2.5 Embedded systems ................................................................. 73

6.3 EVOLUTION ............................................................................................. 73

6.4 RESPONSIBILITY ..................................................................................... 74

vi ESA PSS-05-05 Issue 1 (May 1992)

6.5 MEDIUM ................................................................................................... 74

6.5.1 Online help ....................................................................................... 74

6.5.2 Hypertext.......................................................................................... 75

6.6 CONTENT ................................................................................................. 76

6.6.1 SUM\Table of Contents .................................................................... 78

6.6.2 SUM\1 Introduction .......................................................................... 79

6.6.2.1 SUM\1.1 Intended readership ................................................. 79

6.6.2.2 SUM\1.2 Applicability statement ............................................. 79

6.6.2.3 SUM\1.3 Purpose ..................................................................... 79

6.6.2.4 SUM\1.4 How to use this document ........................................ 79

6.6.2.5 SUM\1.5 Related documents ................................................... 79

6.6.2.6 SUM\1.6 Conventions .............................................................. 79

6.6.2.7 SUM\1.7 Problem Reporting Instructions ................................ 80

6.6.3 SUM\2 Overview Section ................................................................. 80

6.6.4 SUMN3 Instruction Section ............................................................... 80

6.6.5 SUM\4 Reference Section ................................................................ 82

6.6.6 SUM\Appendix A -Error messages and recovery procedures ...... 83

6.6.7 SUM\Appendix В - Glossary ............................................................ 83

6.6.8 SUM\Appendix С - Index ................................................................. 83

CHAPTER 7 LIFE CYCLE MANAGEMENT ACTIVITIES .................................. 85

7.1 INTRODUCTION ....................................................................................... 85

7.2 PROJECT MANAGEMENT PLAN FOR THE TR PHASE .......................... 85

7.3 CONFIGURATION MANAGEMENT PLAN FOR THE TR PHASE .............85

7.4 QUALITY ASSURANCE PLAN FOR THE TR PHASE ............................... 86

7.5 ACCEPTANCE TEST SPECIFICATION .....................................................87

APPENDIX A GLOSSARY .................................................................................. A-1

APPENDIX В REFERENCES ............................................................................. B-1

APPENDIX С MANDATORY PRACTICES ........................................................ C-1

APPENDIX D REQUIREMENTS TRACEABILITY MATRIX .............................. D-1

APPENDIX E INDEX ........................................................................................... E-1

ESA PSS-05-05 Issue 1 (May 1992) 1 INTRODUCTION

CHAPTER 1 INTRODUCTION

PURPOSE

ESA PSS-05-0 describes the software engineering standards to be applied for all deliverable software implemented for the European Space Agency (ESA), either in house or by industry [Ref. 1].

ESA PSS-05-0 defines the second phase of the software development life cycle as the 'Architectural Design Phase' (AD phase). The output of this phase is the Architectural Design Document (ADD). The third phase of the life cycle is the 'Detailed Design and Production Phase' (DD phase). Activities and products are examined in the 'DD review' (DD/R) at the end of the phase.

The DD phase can be called the 'implementation phase' of the life cycle because the developers code, document and test the software after detailing the design specified in the ADD.

This document provides guidance on how to produce the Detailed Design Document (DDD), the code and the Software User Manual (SUM). This document should be read by all active participants in the DD phase, e.g. designers, programmers, project managers and product assurance personnel.

OVERVIEW

Chapter 2 discusses the DD phase. Chapters 3 and 4 discuss methods and tools for detailed design and production. Chapter 5 and 6 describe how to write the DDD and SUM, starting from the templates. Chapter 7 summarises the life cycle management activities, which are discussed at greater length in other guides.

All the mandatory practices in ESA PSS-05-0 relevant to the DD phase are repeated in this document. The identifier of the practice is added in parentheses to mark a repetition. No new mandatory practices are defined.

ESA PSS-05-05 Issue 1 (May 1992) INTRODUCTION

This page is intentionally left blank.

ESA PSS-05-05 Issue 1 (May 1992) 3 THE DETAILED DESIGN AND PRODUCTION PHASE

Date: 2016-01-03; view: 675