Software Development Files Guide

1. PURPOSE

This guide defines the requirements for maintaining Software Development Files (SDFs) to document software during its development.

2. REFERENCES

Software Documentation Guide

3. POLICY

The use of SDFs for a project shall be documented in its project plan. The allocation and number of SDFs shall be determined on a project-by-project basis.

4. PROCEDURE

4.1 Allocation to Software Elements

As a general rule, a separate SDF is established for:

• Each computer software unit
• Each logically related group of units
• Each library application.

As units are integrated into larger units, the SDFs for the units that are integrated can be merged. Similarly, as more units are integrated into an application, the SDFs for the integrated units may also be merged so that there will be a single SDF for each completed application. Original SDF identities are maintained.

The SDFs established for a project are maintained according to the procedures documented in the SDP. SDFs may be generated, controlled, and maintained by automated means. To reduce redundancy of information, the SDFs reference information provided in other documents or SDFs.

4.2 Contents

An SDF includes (directly or by reference) the following information:

• Design considerations and constraints; reference decision logs showing design alternatives; include trade-off studies
• Design documentation and data
• Source code listings
• Unit/integrated units test descriptions
• Unit/integrated units test results
• Code walkthrough/inspection results
• The order of integration of the components of each application together with the tests used to verify each version
• Miscellaneous; include any other information that could be useful in understanding the software element

4.3 Maintenance of the SDFs

The products of preliminary design through unit integration and testing are placed in the SDFs as described in the following paragraphs. Figure 1 graphically depicts the SDF process flow.

4.3.1 Preliminary Design

Establish an SDF for logical groups of units. In the SDF:

• Provide a reference to the design information for the unit.
• Record the test plan for unit integration and testing.

4.3.2 Detailed Design

Establish a separate SDF for each unit of a logically-related group of units established in preliminary design. In the SDF for each unit:

• Provide a reference to the design information for the unit/integrated units.
• Record the test description and schedule for testing the unit/integrated units.

4.3.3 Coding and Unit Testing

The test descriptions and results for the unit being tested are stored in the SDF. Write the test descriptions for unit tests in advance of the test conduct. Add the unit test results to the unit SDF after testing.

4.3.3.1 Software Unit Test Description

A Software Unit Test Description shall be written for each software unit developed for a software development project and put into the SDF. The Software Unit Test Description shall:

• a. Identify the project, the test, the unit(s) tested, and the test personnel.
• b. Document the test objectives, test tools, test input, test output, and expected results for a software unit test.
• c. Specify the step-by-step procedures required to run the test.

4.3.3.2 Software Unit Test Results Report

A Software Unit Test Results Report shall be written for each Software Unit Test Plan written and put into the SDF. The Software Unit Test Results Report shall:

• a. Identify the project, the test that was run, the unit(s) tested, and the test personnel.
• b. Describe the test environment, the test results, and problems encountered while running the test.

4.3.4 Unit Integration and Testing

Add the integrated unit test results to the integrated units SDF. Write the test descriptions for unit integration tests in advance of the test conduct. The results of unit integration testing are recorded in the associated test description, with printout of the results included as necessary. Update the SDFs for those units that change based on unit integration testing. Merge the integrated and tested units' SDF into the next higher SDF until the application SDF is complete.

4.3.4.1 Software Unit Integration Test Description

A Software Unit Integration Test Description shall be written for each application developed for a software development project. The Software Unit Integration Test Description shall:

• a. Identify the project, the test, the unit(s) tested, and the test personnel.
• b. Document the test objectives, test tools, test personnel, test cases, test input, test output, and expected results for a software unit integration test.
• c. Provide a traceability matrix from each test case to the documents containing the requirements being tested.
• d. Specify the step-by-step procedures required to run the test.
• e. Include actual test results.