| |
NASA Software Documentation Standard Appendix A
|
DOCUMENTATION SET OUTLINE AND CHECKLIST
This appendix contains a detailed outline, in the form of a table of contents, for the entire documentation set. This outline also may be used by the project manager as a checklist for tailoring the DIDs to the needs of the project. When used as a checklist, the rules for tailoring provided in Section 3.2 of the Standard must be followed. The completed (tailored) checklist may then be used to decide which DIDs (or portions of DIDs) will be used to produce required documentation.
Section
1.0 INTRODUCTION 1.1 Identification of Document 1.2 Scope of Document 1.3 Purpose and Objectives of Document 1.4 Document Status and Schedule 1.5 Documentation Organization
2.0 RELATED DOCUMENTATION 2.1 Parent Documents 2.2 Applicable Documents 2.3 Information Documents
3.0 MANAGEMENT PLAN
3.1 Purpose and Description of
3.2 Resources, Budgets, Schedules, and Organization 3.2.1 Business Practices Definition and Revision Process 3.2.1.1 Definition of Activities 3.2.1.2 Method and Approach 3.2.1.3 Reporting, Monitoring, and Revision 3.2.2 Work Breakdown Structure 3.2.2.1 Activity Definition 3.2.2.2 Cost Account Definition 3.2.3 Resource Estimation and Allocation to WBS 3.2.3.1 Schedules 3.2.3.2 Funds and Budgets 3.2.3.3 Organization 3.2.3.4 Equipment 3.2.3.5 Materials, Facilities, and Other Resources 3.2.3.6 Management Reserves 3.2.4 Work Authorization
3.3 Acquisition Activities Plan 3.3.1 Procurement Activities Plan 3.3.1.1 Procurement Package Preparation 3.3.1.2 Proposal Evaluation 3.3.1.3 Contract Negotiation 3.3.1.4 Procurement Risks 3.3.2 Organizational Requirements and Life Cycle Adaptations 3.3.2.1 Business Practices, Resources, and Organizational Requirements 3.3.2.2 Life-Cycle Adaptations and Approved Waivers 3.3.3 Management Approach 3.3.3.1 Software Management Responsibilities 3.3.3.2 Categorization and Classification Policy 3.3.3.3 Management Mechanisms 3.3.3.3.1 Requirements Development and Control 3.3.3.3.2 Schedule Development and Control 3.3.3.3.3 Resource Development and Control 3.3.3.3.4 Internal Review Concepts 3.3.3.3.5 External Review Concepts 3.3.3.3.6 Board Support 3.3.3.3.7 Management and Control 3.3.3.4 Documentation Requirements 3.3.3.5 Risk Management 3.3.3.6 Configuration Management 3.3.3.7 System Assurance and Integration 3.3.3.8 Deviation and Waiver Procedures 3.3.3.9 Maintenance of Management Plan 3.3.4 Technical Approach 3.3.4.1 System Requirements and Constraints 3.3.4.2 Integrated System Description 3.3.4.3 Software Requirements Definition Process 3.3.4.4 Software Design and Implementation Process 3.3.4.5 Software Test and Delivery Process 3.3.4.6 Software Maintenance and Updating Process 3.3.4.7 Software System Engineering 3.3.4.7.1 Implementation Policies and Standards 3.3.4.7.2 Interface Control Process 3.3.4.7.3 Data Generation and Management Process 3.3.4.7.4 Performance Assessment Process 3.3.4.7.5 Operations Maintenance Process
3.4 Development Activities Plan 3.4.1 Methodology and Approach 3.4.1.1 Development Engineering 3.4.1.2 Prototyping 3.4.1.2.1 Purpose and Objectives 3.4.1.2.2 Products and By-Products 3.4.1.2.3 Feasibility and Risks 3.4.1.2.4 Description of Characteristics and Methods 3.4.1.2.5 Analysis and Evaluation 3.4.1.3 Integration 3.4.1.4 Engineering and Integration Support Environment 3.4.2 Products and Reports 3.4.2.1 Baselining Process 3.4.2.2 Product Specification Roll-Out Definition 3.4.2.3 Assurance and Test Procedures Roll-Out Definition 3.4.2.4 Reports 3.4.3 Formal Reviews 3.4.4 Interface Control Plan 3.4.4.1 Technical Interfaces 3.4.4.2 Interface Controls 3.4.5 Training for Development Personnel Planning
3.5 Sustaining Engineering and Operations Activities Plan 3.5.1 Sustaining Engineering Process 3.5.2 Product Support 3.5.2.1 User Support 3.5.2.2 User and Operator Training
3.6 Assurance Plan 3.6.1 Quality Assurance Planning 3.6.1.1 Approach and Activities 3.6.1.2 Methods and Techniques 3.6.1.3 Products 3.6.2 Verification and Validation Planning 3.6.2.1 Approach and Activities 3.6.2.2 Methods and Techniques 3.6.2.3 Products 3.6.3 Quality Engineering Assurance Planning 3.6.3.1 Approach and Activities 3.6.3.2 Methods and Techniques 3.6.3.3 Products 3.6.4 Safety Assurance Planning 3.6.4.1 Approach and Activities 3.6.4.2 Methods and Techniques 3.6.4.3 Products 3.6.5 Security and Privacy Assurance Planning 3.6.5.1 Approach and Activities 3.6.5.2 Methods and Techniques 3.6.5.3 Products 3.6.6 Certification Planning 3.6.6.1 Approach and Activities 3.6.6.2 Methods and Techniques 3.6.6.3 Products
3.7 Risk Management Plan 3.7.1 Risk Assessment and Evaluation Process 3.7.2 Technical Risks 3.7.3 Safety Risks 3.7.4 Security Risks 3.7.5 Resource Risks 3.7.6 Schedule Risks 3.7.7 Cost Risks
3.8 Configuration Management Plan 3.8.1 Configuration Management Process Overview 3.8.2 Configuration Control Activities 3.8.2.1 Configuration Identification 3.8.2.2 Configuration Change Control 3.8.2.2.1 Controlled Storage and Release Management 3.8.2.2.2 Change Control Flow 3.8.2.2.3 Change Documentation 3.8.2.2.4 Change Review Process 3.8.2.3 Configuration Status Accounting
3.9 Delivery and Operational Transition Plan 3.9.1 Site Preparation Planning 3.9.1.1 Facility Planning 3.9.1.2 Transition Planning 3.9.2 Delivery Planning 3.9.3 Data Conversion Planning 3.9.4 User Training Planning 3.9.5 Operator Training Planning
4.0 PRODUCT SPECIFICATION
4.1 Concept 4.1.1 Definition of
4.2 Requirements 4.2.1 Requirements Approach and Tradeoffs 4.2.2 External Interface Requirements 4.2.3 Requirements Specification 4.2.3.1 Process and Data Requirements 4.2.3.2 Performance and Quality Engineering Requirements 4.2.3.3 Safety Requirements 4.2.3.4 Security and Privacy Requirements 4.2.3.5 Implementation Constraints 4.2.3.6 Site Adaptation 4.2.3.7 Design Goals 4.2.4 Traceability to Parent's Design 4.2.5 Partitioning for Phased Delivery
4.3 Architectural Design 4.3.1 Design Approach and Tradeoffs 4.3.2 Architectural Design Description 4.3.3 External Interface Design 4.3.3.1 Interface Design 4.3.3.2 Interface Allocation 4.3.4 Requirements Allocation and Traceability 4.3.5 Partitioning for Incremental Development
4.4 Detailed Design 4.4.1 Detailed Design Approach and Tradeoffs 4.4.2 Detailed Design Description 4.4.2.1 Compilation Unit Design and Traceability to Architectural Design 4.4.2.2 Detailed Design of Compilation Units 4.4.3 External Interface Detailed Design 4.4.3.1 Interface Allocation Design 4.4.3.2 Physical Interface Design 4.4.4 Coding and Implementation Notes 4.4.5 Firmware Support Manual 4.4.5.1 Devices 4.4.5.1.1 Physical Description 4.4.5.1.2 Installation and Replacement 4.4.5.1.3 Limitations 4.4.5.2 Programming Tools 4.4.5.2.1 Equipment 4.4.5.2.2 Software 4.4.5.2.3 Programming Procedures 4.4.5.3 Security Implications
4.5 Version Description 4.5.1 Product Description 4.5.2 Inventory and Product 4.5.2.1 Materials Released 4.5.2.2 Product Content 4.5.3 Change Status 4.5.3.1 Installed Changes 4.5.3.2 Waivers 4.5.3.3 Possible Problems and Known Errors
4.6 User Documentation 4.6.1 User's Guide 4.6.1.1 Overview of Purpose and Function 4.6.1.2 Installation and Initialization 4.6.1.3 Startup and Termination 4.6.1.4 Functions and their Operation 4.6.1.5 Error and Warning Messages 4.6.1.6 Recovery Steps 4.6.2 User's Training Materials
4.7 Operational Procedures Manual 4.7.1 System Preparation and Set-up Procedures 4.7.2 Standard Operating Procedures 4.7.3 Fault and Recovery Procedures 4.7.4 Emergency Procedures 4.7.5 Diagnostic Procedures
4.8 Maintenance Manual 4.8.1 Implementation Details 4.8.2 Modification Aids 4.8.3 Code Adaptation
5.0 ASSURANCE AND TEST PROCEDURES 5.1 Quality Assurance 5.2 Verification and Validation 5.2.1 Inspections, Reviews, and Analyses 5.2.2 Testing 5.2.2.1 Unit Testing 5.2.2.2 Integration Testing 5.2.2.3 Acceptance Testing
5.3 Quality Engineering Assurance 5.4 Safety Assurance 5.5 Security and Privacy Assurance 5.6 Certification
6.0 MANAGEMENT, ENGINEERING, AND ASSURANCE REPORTS NASA-DID-R001 Certification Report NASA-DID-R002 Audit Report NASA-DID-R003 Inspection Report NASA-DID-R004 Discrepancy (NRCA) Report NASA-DID-R005 Engineering Change Proposal NASA-DID-R006 Lessons Learned Report NASA-DID-R007 Performance/Status Reports NASA-DID-R008 Assurance Activity Report NASA-DID-R009 Test Report NASA-DID-R010 Waiver/Deviation Request NASA-DID-R011 Review Report
7.0 ABBREVIATIONS AND ACRONYMS
8.0 GLOSSARY
9.0 NOTES
10.0 APPENDICES
Return to Beginning of Appendix
Return to NASA Software Documentation Standard
If you have any questions or comments about the SATC, contact:
Dr. Linda Rosenberg
NASA/GSFC
Code 302 - Bldg 6
Greenbelt, MD 20771
Linda.Rosenberg@gsfc.nasa.gov
This page was last updated on:
06/29/99