The Digital Guide To Software Development

Preface

Chapter 1 The Digital Phase Review Process


1.1 Strategy and Requirements Phase


1.2 Planning and Preliminary Design Phase


1.3 Detailed Design and Implementation Phase


1.4 Qualification Phase


1.5 Manufacturing Phase


1.6 Retirement Phase

Chapter 2 Software Development Tools


2.1 Software Development Tools


2.1.1 VAXset


2.1.2 VAX Language-Sensitive Editor


2.1.3 VAX Source Code Analyzer


2.1.4 VAX DEC/Test Manager


2.1.5 VAX Performance and Coverage Analyzer


2.1.6 VAX DEC/Code Management System


2.1.7 VAX DEC/Module Management System


2.1.8 VAX SCAN


2.1.9 VAXCDD/PLUS


2.1.10 The VMS Debugger


2.2 Management and Communications Tools


2.2.1 VAX Software Project Manager


2.2.2 The VAX/VMS Mail Utility


2.2.3 VAX Notes


2.3 Documentation Tools


2.3.1 VAX Digital Standard Runoff


2.3.2 VAX Document


2.3.3 DECwrite


2.4 VMS Utilities


2.4.1 The Message Utility


2.4.2 The Command Definition Utility


2.4.3 The VMS Run-Time Library


2.4.4 VAX C Run-Time Library


2.5 Summary of Software Development Tools

Chapter 3 Project Management


3.1 Development Projects and Teams


3.1.1 Product Team


3.1.2 Development Team


3.2 Project Planning and Control


3.2.1 Project Schedule


3.2.2 Project Control


3.2.3 The VAX Software Project Manager


3.3 Project Documentation


3.3.1 Marketing Requirements Document


3.3.2 Product Requirements Document


3.3.3 Alternatives/Feasibility Study


3.3.4 Product Specification


3.3.5 Development Plan


3.3.6 High-Level Design Document


3.3.7 Detailed Design Document


3.3.8 Field Test Plan


3.3.9 Field Test Report

Chapter 4 Planning and Preliminary Design


4.1 High-Level Design


4.1.1 High-Level Design Process


4.1.2 High-Level Testing Analysis


4.2 Design Methodologies


4.3 Prototypes


4.4 Human Interface Design


4.4.1 Usability Issues


4.4.2 DECwindows


4.5 Design Reviews


4.5.1 Design Review Guidelines


4.6 Standards


4.6.1 The VAX Procedure Calling and Condition Handling Standard


4.6.2 VAX/VMS Modular Programming Standard


4.6.3 IEEE Standards


4.7 Planning International Products

Chapter 5 Design and Implementation


5.1 Detailed Design Process


5.1.1 Logical Modules and Physical Modules


5.1.2 Design Documents


5.2 Implementing Base Levels


5.2.1 Types of Base Levels


5.2.2 Requirements Analysis


5.2.3 Build Procedures


5.2.4 Product Kits

Chapter 6 Coding Guidelines for Implementation


6.1 Selecting Guidelines


6.1.1 Examine Existing Source Code


6.1.2 Use the Language-Sensitive Editor


6.1.3 Build Program Modules


6.2 Choosing an Implementation Language


6.3 Improving Code Readability


6.3.1 Symbols


6.3.2 Case Conventions


6.3.3 Spacing


6.3.4 Formatting Comments


6.4 Naming Conventions


6.4.1 File Names


6.4.2 Directories


6.4.3 Procedures


6.4.4 Modules


6.4.5 Variables


6.4.6 Naming Conventions for Objects


6.4.7 File Image IDs


6.5 Code Reviews


6.5.1 Informal Walkthroughs


6.5.2 Formal Inspections


6.5.3 Code Inspection Guidelines

Chapter 7 The Testing Process


7.1 Levels of Testing


7.1.1 Unit Testing


7.1.2 Integrated Testing


7.2 Types of Tests


7.2.1 White Box Tests


7.2.2 Black Box Tests


7.3 Testing and Design


7.3.1 Design Considerations


7.3.2 Regression Testing


7.4 Performance Testing


7.4.1 Running Regression Tests


7.4.2 Resolving Performance Problems


7.5 Summary of Testing Guidelines

Chapter 8 Qualification


8.1 Preparing for Field Test


8.1.1 Problem Report System


8.1.2 Internal Field Test


8.1.3 Early Evaluation Field Test


8.2 Conducting the External Field Test


8.2.1 Fixing Errors


8.2.2 Final Verification: Field Test Upgrade Kits


8.3 Closing the Field Test


8.3.1 Manufacturing Verification


8.3.2 Field Test Reports


8.3.3 Product Evaluation Report


8.3.4 Release Notes

Chapter 9 Maintenance


9.1 Planning for Maintenance


9.2 Maintenance Procedures


9.2.1 Project Environment


9.2.2 Project Conventions


9.2.3 Project Communication


9.2.4 Design Documentation


9.2.5 Test Plans


9.2.6 Code Conventions


9.2.7 Build Procedures


9.2.8 Maintenance Document


9.2.9 DEC/CMS Libraries


9.2.10 Problem Reports


9.3 Software Development Productivity


9.3.1 Productivity Metrics


9.3.2 Measurement Techniques

Appendix A Coding Conventions for VAX C

A.1 Support Tools

A.2 Module Organization

A.3 Organization of C Source Files

A.4 Organization of Header Files

A.5 Comments

A.6 Naming Conventions

A.6.1 General Considerations

A.6.2 Local Names

A.6.3 Global Names

A.6.4 Reserved Names

A.7 Definitions

A.8 Declarations

A.8.1 Structure Declarations

A.8.2 Function Declarations

A.8.3 Type Compatibility

A.8.4 Pointers

A.9 Functions

A.9.1 Definition

A.9.2 Exception Handling

A.10 Statements

A.10.1 Indentation of Compound Statements

A.10.2 The if Statement

A.10.3 The for Statement

A.10.4 The while and do Statements

A.10.5 The Switch Statement

A.10.6 The Goto Statement

A.11 Expressions and Operators

A.12 Portability

Appendix B International Product Development

B.1 International Product Model

B.2 International Software Design Guidelines

Appendix C Industry Standards

C.1 IEEE Standards

C.2 Sources for Other Standards

Appendix D Additional Reading

D.1 Applications and Tools

D.2 Software Development

Trademarks

Index

Examples


6-1 LSE Template for a Bliss Module Preface


6-2 LSE Template for a Bliss Module's Declaration


6-3 LSE Template for a Bliss Routine


6-4 LSE Template for a C Module


6-5 Proper Capitalization in a Pascal Program


6-6 Spacing in a BASIC Program


6-7 Block Comments in a FORTRAN Program


6-8 Justified Line Comments in a C Program


6-9 Unjustified Line Comments in a C Program


6-10 Block Comment in a C Program

Figures


1-1 The Phase Review Process for Product Development


1-2 Strategy and Requirements Phase


2-1 VMS Tools for Software Development


3-1 Product Team Interactions


3-2 Development Team Members


3-3 Mapping Units to Calendar


3-4 Project Control Model


3-5 Information Flow Among Phase Documents


4-1 Planning and Preliminary Design Phase


4-2 Modular Design Levels


4-3 Design Review Process


5-1 Design and Implementation Phase


7-1 Code Testing Process


7-2 Unit and Integrated Levels of Testing


7-3 DEC/Test Manager and Regression Testing


7-4 Performance Test Process


9-1 Use of DEC/CMS Groups for Maintenance


9-2 Variant Development


9-3 Multiple DEC/CMS Libraries

B-1 International Product Model

Tables


2-1 Data Types Supported by VAX Software Project Manager


2-2 VMS Run-Time Library Facilities


3-1 Responses to Common Task-Related Problems


4-1 Sample Usability Specification Table


4-2 DECwindows Run-Time Libraries


4-3 VAX Register Use


5-1 Problems in Preparing Base Levels


6-1 Naming Conventions for Common Files


6-2 Examples of Entry Point Names


6-3 Relationships Among File, Module, and Procedure Names


6-4 Global Variable Code Values


6-5 Naming Conventions for Objects


7-1 White Box Tests and Black Box Tests


8-1 Resolution of Critical Errors


9-1 Relative Costs of Fixing Software Errors