- 1. Minimum Recommended Content
- 2. Rationale
- 3. Guidance
- 4. Small Projects
- 5. Resources
- 6. Lessons Learned
Return to 7.18 - Documentation Guidance
1. Minimum Recommended Content
- Channelization data (e.g., bus mapping, vehicle wiring mapping, hardware channelization).
- Input/Output (I/O) variables.
- Rate group data.
- Raw and calibrated sensor data.
- Telemetry format/layout and data.
- Data recorder format/layout and data.
- Command definition (e.g., onboard, ground, test specific).
- Effecter command information.
- Operational limits (e.g., maximum/minimum values, launch commit criteria information).
The preparation, documentation, and use of a Software Data Dictionary (SDD) enable uniform communication among the team members on a software development project. The SDD provides key information needed for the implementation, testing, and maintenance of the software product. The data dictionary allows developers, maintainers, and analysts to access information about the tables, fields, procedures, processes, and other information in the system. Customers and users have a ready reference of information about the software work product.
The Software Data Dictionary (SDD) may be a stand-alone project document; it may be included as part of an electronic database; or it may be written as an appendix in one of the project's primary documents, e.g., the systems requirement specification or the software design description document. Either format (hardcopy or electronic) is compliant with the requirement.
A data dictionary includes a set of meta-data that contains the definition and representation of data elements. A data dictionary lists all data elements but does not say anything about the relationships between elements. It gives a single point of reference for a data repository of an organization.
Some of the typical components of a data dictionary entry are:
- Name of the table.
- Name of the fields in each table.
- Data type of the field (integer, date, text, etc.).
- Brief description of the expected data for each field.
- Length of the field.
- Default value for that field.
- Whether the field is Nullable or Not Nullable.
- Constraints that apply to each field, if any.
Designers, programmers, users, maintainers, and administrators of a computer system as an administrative resource are the main users of the SDD. Data dictionaries are used to maintain information on systems hardware and software configurations, documentation, application, and users, as well as other relevant information.
The SDD can be produced:
- Automatically, using a software tool to interrogate the database and to map its content.
- Manually, by examining the code to determine and record its content.
- By a combination of the two.
The data in the SDD may be in the form of tables. Typically, the table definitions define the tables in the database, including a brief description of their use, the key fields, the primary key, and a list of the fields.
Guidance and examples for the required content of the SDD are included in the bullets below:
- Channelization data, e.g., bus mapping, vehicle wiring mapping, hardware channelization, provides a description of each data channel and where it maps to.
- Input/Output (I/O) variables provide a description of each I/O variable. Specify format, unit of measure, and definition.
- Rate group data, e.g., science data is collected at 1000 Hz, and health and status data is collected at 1 Hz.
- Raw and calibrated sensor data provide a description of the format, units of measure, and definition of each sensor. Specify data reduction for transforming raw data into calibrated data.
- Sensor data qualification criteria and senor data disqualification criteria.
- Telemetry format/layout and data provide a description of the telemetry mode, format, packetization and definition:
- Specify what types of packets are allowed to be sent for each of the telemetry modes.
- Specify maximum data rate for each mode.
- The telemetry format usually includes data type, data representation, data size, acceptable range values, unit of measure, and the meaning of the data for each field.
- Data recorder format/layout and data
- Command definition, e.g., onboard, ground, test specific, provides a description for each of the commands processed by the software work package. Include the purpose, function, the format of the command and its parameters, and any restrictions attendant to the command.
- Effecter command information provides information about the setting of names or flags that cause command executions in the software work products.
- Operational limits, e.g., maximum/minimum values, launch commit criteria information.
- Scheduling procedures and inter-processor/inter-task communications mechanisms, including time-rigid sequencing, preemptive scheduling and interrupts.
- Partitioning methods, means of preventing partition breaches, partitioning faults and partitioning metric data.
Other candidate information for the software data dictionary includes:
- Data channelization.
- Data description.
- Data location.
- Data relationships.
- Data sources and destinations.
- Data structure.
- Data type.
- Data units.
- Data use.
- Data values, e.g., range and calibration data.
- Database schema and database management systems.
- Object-oriented class and method descriptions.
- Entity-relationship diagrams.
- Input and output data conversions and units.
Finally, the SDD includes descriptions of each process carried by the database system, including:
- Where and how the data enters the system.
- What is done to the data, at what stage, and why.
- What the outputs of the system are (if any).
- How to control, update, and distribute the SDD.
Additional guidance related to the production of the SDD may be found in the work products described on other tabs in this topic.
4. Small Projects
A software data dictionary is applicable to all projects regardless of size. Small projects may be able to leverage SDDs, or portions of dictionaries, from previous projects, as long as those projects had similar data structures.
NASA users find this in the Tools Library in the Software Processes Across NASA (SPAN) site of the Software Engineering Community in NEN.
The list is informational only and does not represent an “approved tool list”, nor does it represent an endorsement of any particular tool. The purpose is to provide examples of tools being used across the Agency and to help projects and centers decide what tools to consider.
6. Lessons Learned
6.1 NASA Lessons Learned
- Develop and Test the Launch Procedure Early (1997). Lesson Number 0609 565: The Abstract states: "During the terminal countdown for the first attempted launch of Cassini, spacecraft telemetry channels indicated a false alarm condition that delayed verification of spacecraft readiness for launch, and contributed to a delay on the first launch day. The anomaly was traced to erroneous telemetry documentation. Develop and release the launch procedure early enough for comprehensive testing before launch. Rigorously test and verify all telemetry channels and their alarms and ensure documentation such as telemetry definitions is kept up to-date."
6.2 Other Lessons Learned
No other Lessons Learned have currently been identified for this requirement.