NASA Software Documentation Standard NASA-DID-999

NASA-DID-999
TEMPLATE
DATA ITEM DESCRIPTION

TABLE OF CONTENTS

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 - N.0 [Major subsections of the volume being rolled-out into a separate document] N+1.0 ABBREVIATIONS AND ACRONYMS N+2.0 GLOSSARY N+3.0 NOTES N+4.0 APPENDICES

EXPLANATORY NOTE

The purpose of the template is to describe the set of common sections that are to appear in the document specified by the Standard and in any rolled-out documents. When using this template for the volume itself rather than for a rolled-out document, the word "Volume" should be used in place of "Document" in the following section descriptions.

1.0 INTRODUCTION

1.1 Identification of Document

Identify this physical document in terms of its relationship to the parent volume(s) in this documentation set. For documentation set volumes, identify the parent(s) in the decomposition tree for the software system. For example:

"This is the Management Plan of the XYZ Software System."

"This is the Concept Document of the Product Specification of the XYZ Software System."

"This is the Input/Output Unit Test Procedures of the Assurance and Test Procedures of the XYZ Software System."

1.2 Scope of Document

Describe the area of cognizance, responsibility, and applicability for this document.

1.3 Purpose and Objectives of Document

Describe the purpose and objectives for this document concisely and in specific terms.

1.4 Document Status and Schedule

Describe the status, including goals and dates, for production or revision of the document. Documentation is often generated incrementally or iteratively. If this is the case for this document, also summarize here the planned updates and their release dates.

1.5 Documentation Organization

Briefly describe the contents of each major section within this document and the contents of each appendix.

Provide a documentation tree (text or graphic) of all documents produced for the project showing the relationship between the documents, and where this document fits in that tree.

Include a list, in the form of a table of contents, which shows for this document which sections and subsections of the standard have been:

a. Marked N/A

b. Added

c. Marked with a pointer

2.0 RELATED DOCUMENTATION

The purpose of this section is to provide the references or bibliography for this document.

Cite documents by short or common title (if any), full title, version or release designator (if appropriate), date, publisher or source, and document number or other unique identifier.

2.1 Parent Documents

Begin this section as follows, depending upon whether this is a rolled out document or a top-level document:

"The following document(s) is (are) parent to this document:"

or:

"The following volume(s) is (are) the parent from which this document's scope and content are derived:"

(For top-level documents, any parent documents will be outside the documentation set.)

If the document is for a lower level element, cite the appropriate document at the next higher level. For example, a Management Plan would cite the Management Plan for the next higher level software system, or the Product Specification would cite the Management Plan and the parent's Product Specification. If there is no higher level, state "None."

If this is a rolled-out document, cite the parent document. If this is a rolled-out document from another rolled-out document, cite each document in the hierarchical path back to the parent document, starting with the document immediately superior to this one.

2.2 Applicable Documents

Provide the citations for every document (other than the parent) referenced within this volume, or which are directly applicable, or contain policies or other directive matters that are binding upon the content of this volume. Also include the DID number of the highest level DID and, if appropriate, section number, used to prepare this document.

2.3 Information Documents

Provide the citations for documents which, although not directly applicable, amplify or clarify the information presented in this volume. State if these are not binding, or indicate the relationship of the documents listed here to this document.

3.0 - N.0 CONTENT FOR ROLLED-OUT SECTION

Each major subsection of the section of the volume, or of a rolled-out document thereof, being rolled-out into a separate subordinate volume becomes a major section in the rolled-out volume.

N+1.0 ABBREVIATIONS AND ACRONYMS

This section follows the sections containing the content for the rolled-out section.

The abbreviations and acronyms section contains an alphabetized list of the definitions for abbreviations and acronyms used in this document.

N+2.0 GLOSSARY

The glossary contains an alphabetized list of definitions for special terms used in the document, i.e., terms used in a sense that differs from or is more specific than the common usage for such terms.

N+3.0 NOTES

Use this section to present information that aids in understanding the information provided in previous sections, and which is not contractually binding.

N+4.0 APPENDICES

The appendices contain material that is too bulky, detailed, or sensitive to be placed in the main body of text. Refer to each appendix in the main body of the text where the information applies. Appendices may be bound separately, but are considered to be part of the document and shall be placed under configuration control as such.

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