Table of Contents | Appendix C-26 | Appendix C-28

APPENDIX C-27

SOFTWARE DEVELOPMENT DOCUMENT

1.0      INTRODUCTION

The software development document contains all preparations pertaining to the development of each unit or module, including the software, test cases, test results, approvals, and any other items that will help to explain the functionality of the software. The document is dynamic and is maintained by the system development team and should be constantly updated as the system's development progresses. The software development folder should include the following information for each unit:

•      Description of the unit's functionality in narrative format

•      Description of development methodologies used

•      Requirements in the functional requirements document allocated to this unit or module

•      Completed traceability matrix displaying the unit's test cases satisfying the functiona
       requirements in the test plan

•      Source code listing

•      Controlled libraries/directories/tables

•      All data necessary to conduct unit testing

•      Unit test results and analysis

•      System Technical Lead sign off for design walk-through, approval of code, and
       completion of each unit

•      Completed Software Development Document Check-Off sheet (attached)

2.0      ROLES AND RESPONSIBILITIES

The team members have the following roles and responsibilities:

•      The application developer assigned the primary responsibility for the module or unit
       creates a file folder for the unit, labels it according to the name of the unit, and places it in
       the appropriate place in the project team file cabinet.

•      The application developer(s) add copies of the indicated documentation to the folder as
       they are created.

•      The project QA representative reviews the contents of the folder for completeness, and
       points out discrepancies to the developer assigned primary responsibility for the module
       or unit.

•      The developer assigned primary responsibility for the module or unit completes the
       Software Development Document Check-Off sheet and arranges for the System
       Technical Lead review and approval when needed.

•      The folder is available to all project team member for review, but if removed from the file
       cabinet, it must be replaced with a check-out card indicating who checked it out, when,
       and where it will be located.

2.1      PROCESS

Fill out the following sections of the Check-Off sheet:

•      Requirements - Place a checkmark to the left of each question when it is determined
       that the answer is "Yes." This indicates that there is a match between the requirements
       traceability matrix and the requirements addressed by this module.

•      Functionality - Place a checkmark to the left of each question when it is determined that
       the answer is "Yes." This indicates that a complete narrative description of the module's
       functionality is available, that a walk-through of the module's design was conducted before
       the start of the programming, and that System Technical Lead approval was granted to
       begin the programming work.

•      Source Code - Place a checkmark to the left of the question when it is determined that a
       current copy of the program source listing has been placed in the folder.

•      Libraries, Directories, and Tables - Place a checkmark to the left of the question
       when it is determined that the program source code and copybook libraries and
       associated electronic tables are identified, and copies, as needed are in the folder.

•      Development Methodologies - Place a checkmark to the left of the question when it is
       determined that the programming methodology descriptions are all included in the folder.

•      Test Data - Place a checkmark to the left of each question when it is determined that the
       location and identity of all needed unit test data are included in the folder.

•      Test Analysis - Place a checkmark to the left of the question when it is determined that
       the unit has been thoroughly tested.

•      Sign-Off - Date and sign the certification for completion of coding and unit testing for the
       module.

SOFTWARE DEVELOPMENT FOLDER CHECK-OFF SHEET

REQUIREMENTS

Has each requirement in the functional requirements document allocated to this unit been identified using the traceability matrix?

Have derived requirements found during the development of this unit been identified, justified, and put in the functional requirements document?

FUNCTIONALITY

Is the functionality of this unit fully described?

Is the description in narrative form?

Was a design walk-through conducted?

Was permission granted to begin programming?

SOURCE CODE

Is the source code listing of the unit included in this folder?

LIBRARIES, DIRECTORIES, AND TABLES

Are all coded entities included in the folder?

DEVELOPMENT METHODOLOGIES

Are all development methodologies for the development effort described in the folder?

TEST DATA

Are all data necessary to conduct testing referenced in this folder?

TEST ANALYSIS

Was the unit thoroughly tested and were all logical paths verified?

SYSTEM DEVELOPER

I certify that this software development document is complete, the unit ________ defined in this folder has successfully completed development and unit testing, and the unit is ready to be baselined and integrated into the system

 

 

 

Date ________          System Developer: _________________

                   System Technical Lead Initials: ________

Table of Contents | Appendix C-26 | Appendix C-28