| |
NASA Software Documentation Standard Appendix B
|
MASTER DOCUMENTATION DATA ITEM DESCRIPTIONS
This appendix contains specifications for the format, outline, and content of the Software Documentation Set DID and the Template DID. These two DIDs are used as support structures for project documentation.
The Software Documentation Set DID (NASA-DID-000) provides a top-level reference for the four required volumes of a documentation set. The four volumes may be contained in the documentation set created using this DID or rolled-out into separate documents with references to this top-level document.
The Template DID (NASA-DID-999) provides the format and content for both the front matter (Introduction, Related Documents) and back matter (Abbreviations and Acronyms, Glossary, Notes, Appendices) to be contained in all separate documents. It also provides detailed instructions for preparing documents that are rolled out. Note that this DID does not represent a particular separate document, but is used to generate the format for sections that are to be contained in physically separate documents.
Table B-1. DID Index
DID Number Title
NASA-DID-000 Software Documentation Set DID NASA-DID-999 Template DID
TABLE OF CONTENTS
1.0 INTRODUCTION 2.0 RELATED DOCUMENTATION 3.0 MANAGEMENT PLAN 4.0 PRODUCT SPECIFICATION 5.0 ASSURANCE AND TEST PROCEDURES 6.0 MANAGEMENT, ENGINEERING, AND ASSURANCE REPORTS 7.0 ABBREVIATIONS AND ACRONYMS 8.0 GLOSSARY 9.0 NOTES 10.0 APPENDICES
The purpose of the Software Documentation Set DID is to provide a top-level document for the four volumes of the documentation set. Any or all of the four volumes may be contained in this document. Those volumes that are not contained in this document are referenced in this document.
Refer to the Template DID (NASA-DID-999) for a detailed structure and content description of this section.
Refer to the Template DID (NASA-DID-999) for a detailed structure and content description of this section.
Refer to NASA-DID-M000 for Management Plan format and content.
Refer to NASA-DID-P000 for Product Specification format and content.
Refer to NASA-DID-A000 for Assurance and Test Procedures format and content.
Refer to NASA-DID-R000 for Management, Engineering, and Assurance Reports format and content.
Refer to the Template DID (NASA-DID-999) for a detailed content description of this section.
Refer to the Template DID (NASA-DID-999) for a detailed content description of this section.
Refer to the Template DID (NASA-DID-999) for a detailed content description of this section.
Refer to the Template DID (NASA-DID-999) for a detailed content description of this section.
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
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.
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:
Describe the area of cognizance, responsibility, and applicability for this document.
Describe the purpose and objectives for this document concisely and in specific terms.
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.
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:
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.
Begin this section as follows, depending upon whether this is a rolled out document or a top-level document:
or:
(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.
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.
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.
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.
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.
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.
Use this section to present information that aids in understanding the information provided in previous sections, and which is not contractually binding.
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.
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