NASA Software Documentation Standard Appendix F

TABLE OF CONTENTS

1.0	INTRODUCTION
2.0	RELATED DOCUMENTATION
3.0	REPORTS
4.0	ABBREVIATIONS AND ACRONYMS
5.0	GLOSSARY
6.0	NOTES
7.0	APPENDICES

EXPLANATORY NOTE

The purpose of the Management, Engineering, and Assurance Reports is to provide a logical home for all reports specified in the Management Plan and generated throughout the life cycle. This document provides a mechanism for storing and retrieving each individual report.

1.0 INTRODUCTION

EXPLANATORY NOTE

The purpose of the Certification Report is to present to management a summary of certification activity results for a product or group of products. The requirements for the specific certification activity and associated reports and the frequency of their generation are specified in the Management Plan. The description of the supporting test(s) (test specifications, test data, test results, etc.) and other assurance activities is given in the Assurance and Test Procedures. The description of the product being certified is given in the Product Specification.

The information listed below is considered to be the minimum content for a Certification Report. The specific content and format for this report is specified in the Management Plan.

Topics to be included in the Certification Report are:

a. Identity of the certification activity as defined in the Assurance and Test Procedures

b. Version identification of product under certification as defined in the Product Specification plus any environment definition

c. Date of certification activity

d. Certification team members (if appropriate)

e. Certification witnesses (if appropriate)

f. Agency granting certification

g. Status of certification activity

1. Status of activity

2. Certification criteria unfulfilled

3. Limitations restricting or precluding certification

EXPLANATORY NOTE

The purpose of the Audit Report is to provide status on an audit activity to management. The requirement for the audit activity and associated reports and the frequency of their generation are specified in the Management Plan. The description of an audit activity is given in the Assurance and Test Procedures. An audit may apply to either a product or a process. The information listed below is considered to be the minimum content for an Audit Report. The specific content and format for this report is specified in the Management Plan.

Topics to be included in the Audit Report are:

a. Identity of the audit as defined in the Assurance and Test Procedures

b. Version identification of product or process under audit and any environment identification

c. Date of audit

d. Audit team members (if appropriate)

e. Anomalous conditions encountered and recommendations made

f. Audit summary and status

g. Date of follow-up audit

EXPLANATORY NOTE

The purpose of the Inspection Report is to provide the status of an inspection to management. The requirement both for the inspection activity and for associated reports and the frequency of their generation are specified in the Management Plan. The description of the inspection criteria, etc., is given in the Assurance and Test Procedures. The description of the product being inspected is given in the Product Specification. The information listed below is considered to be the minimum content for an inspection report. The specific content and format for this report is specified in the Management Plan.

Topics to be included in the Inspection Report are:

a. Identity of the inspection as defined in the Assurance and Test Procedures

b. Version identification of the product under inspection as defined in the Product Specification plus environment identification

c. Date of inspection

d. Inspection team members

e. Anomalous conditions encountered and recommendations made

f. Inspection status and summary of results

EXPLANATORY NOTE

The purpose of the Discrepancy (NRCA) Report is to state a discrepancy to a product or Product Specification. The process of filing a report of this type may be referred to as nonconformance reporting and corrective action (NRCA). A nonconformance is defined as any deviation of a product or process from applicable requirements, standards, or procedures. The requirement for reports of this type and the process for analysis and disposition is specified in the Management Plan. The information listed below is considered to be the minimum content for a Discrepancy (NRCA) report.

Topics to be included in the Discrepancy (NRCA) report are:

a. Report identification (Discrepancy Report or NRCA number)

b. Originator identification including

1. Name and organization

2. Address and phone

3. Unit or site of occurrence

c. Product identification including

1. Name

2. Version number (plus release date if applicable)

3. If applicable, environment information (e.g., hardware and operating system for a software product)

4. Life cycle phase in which nonconformance detected

d. Discrepancy Report (NRCA) information including

1. Title

2. Date

3. Type of nonconformance

4. Description

5. Recommendation for proposed solution (if any), including code, data, or documentation where corrective action must be taken

e. Approval authority including

1. Criticality

2. Disposition

3. Resolution

4. Implementation schedule

5. Date/version of the item in which the corrective action will be included

6. Authority signature

7. Date tested

8. Date of closure

EXPLANATORY NOTE

The purpose of the Engineering Change Proposal (ECP) is to state a suggested change to a product. The requirement for use of ECPs and the process for their analysis and disposition is specified in the Management Plan. The information listed below is considered to be the minimum content for an ECP. The specific format for the ECP Report to be used is specified in the Management Plan.

Topics to be included in the ECP are:

a. Proposal identification

b. Originator identification including

1. Name and organization

2. Address and phone

c. Product (including documents) identification including

1. Name or title

2. Version number (plus release date if applicable)

3. If applicable, environment information (e.g., hardware and operating system for a software product)

d. Proposal information including

1. Title

2. Date

3. Classification (e.g., major or minor)

4. Priority

5. Description of proposed change

6. Recommendation (if any)

e. Proposal analysis including

1. Classification

2. Resources required to implement change

3. Effect upon operational personnel and training

4. Suggested resolution

5. Reference to associated analysis

f. Change authority including

1. Disposition

2. Resolution

3. Implementation schedule

4. Authority signature

EXPLANATORY NOTE

The purpose of the Lessons Learned Report is to record, for the purpose of improvement in future applications, the major strengths and weaknesses of the management, engineering, and assurance process for an application, and the resultant product. This is not an evaluation of the current application; rather, it is a distillation of the experience gained that will be useful when applied to similar activities in the future.

Topics to be included in the Lessons Learned Report are lessons learned on matters such as:

a. Author or submitter

b. Identification of software

c. Unique approaches for methods, practices, and standards

d. Useful management planning and control techniques

e. Major problem areas and how resolution was attained; identification of unresolved problems

f. Successful aspects and shortcomings of the planning, development, and assurance process

g. Recommendation for future applications

EXPLANATORY NOTE

The purpose of the Performance/Status Report is to inform management about the performance or status of a process or product. The requirement for reports of this type and their frequency are specified in the Management Plan. The information listed below is considered the minimum content for a Performance or Status Report. The specific content and format is specified in the Management Plan.

Topics to be included in performance/status reports are:

a. Identification of activity or process to which this report relates

b. Author or submitter

c. Accomplishments

d. Significant variances in planned versus actual performance

e. Open items, problems, newly identified risks, and status on previously reported risks.

f. Recommendations for corrective action

EXPLANATORY NOTE

The purpose of the Assurance Activity Report is to record the conduct and status of a formal or informal review, walkthrough, inspection, analysis, or similar product assurance activity, as specified in the Management Plan. A description of the assurance activity is documented in the Assurance and Test Procedures. The specific content and format for this report is specified in the Management Plan.

Topics to be included in a Assurance Activity Report are:

a. Identification of the activity as specified in the Assurance and Test Procedures

b. Identification of the product or process evaluated

c. Identification of the organization or person responsible for the product or process

d. Date and place of the assurance activity

e. List of assurers and organizations represented

f. Summary of activity results and status

g. List of actions to be taken, and by whom, as determined during the activity

h. Approval action and authority taken as a result of the activity

EXPLANATORY NOTE

The purpose of the Test Report is to provide the status of a test or a sequence of tests to management. The requirement for the tests and reports of this type and the frequency of their generation are specified in the Management Plan. The description of the test (test specifications, test data, test results, etc.) is given in the Assurance and Test Procedures. The description of the product tested is given in the Product Specification. The information listed below is considered to be the minimum content for a Test Report. The specific content and format for this report is specified in the Management Plan.

Topics to be included in the Test Report are:

a. Identity of the test as defined in the Assurance and Test Procedures

b. Version identification of product under test as defined in the Product Specification

c. Date of test

d. Test team members (if appropriate)

e. Test witnesses (if appropriate)

f. Anomalous conditions encountered and recovery procedures attempted

g. Test status and summary of results

EXPLANATORY NOTE

The purpose of the Waiver/Deviation Request is to obtain a waiver or deviation from a required process or product. The requirement for requests of this type and the process for analysis and disposition are specified in the relevant Management Plan (or parent plan). The information listed below is considered to be the minimum content for a Waiver/Deviation Request. The specific content and format for this request is specified in the Management Plan.

Topics to be included in the waiver/deviation request are:

a. Waiver/deviation identification

b. Requester identification including

1. Name and organization

2. Address and phone

c. Product or process identification including

1. Name

2. Version number (release date if applicable)

d. Waiver/deviation description

e. Rationale for acceptance of waiver/deviation

f. Schedule, cost, or other resources impact analysis

g. Safety, security, or other risk analysis

h. Change authority including

1. Disposition

2. Resolution

3. Implementation schedule

4. Authority signature

EXPLANATORY NOTE

The purpose of the Review Report is to provide the status of a formal review to management. The requirement both for the review activity and for associated reports and the frequency of their generation are specified in the Management Plan. The description of the review criteria, etc., is given in the Assurance and Test Procedures. The description of the product being inspected is given in the Product Specification. The information listed below is considered to be the minimum content for a review report. The specific content and format for this report is specified in the Management Plan.

Topics to be included in the Review Report are:

a. Identity of the review as defined in the Assurance and Test Procedures

b. Version identification of the product under review as defined in the Product Specification plus environment identification

c. Date of review

d. Review participants

e. Errors, discrepancies, and omissions encountered and recommendations made

f. Review status and summary of results

g. Date of follow-up review