Program Specifications Template - HUD



[pic]

PROGRAM

SPECIFICATIONS

Project or System Name

U.S. Department of Housing and Urban Development

Month, Year

Revision Sheet

|Release No. |Date |Revision Description |

|Rev. 0 |5/30/00 |Program Specifications Template and Checklist |

|Rev. 1 |6/6/00 |Revised section numbering |

|Rev. 2 |4/11/02 |Conversion to WORD 2000 format |

| | | |

| | | |

| | | |

| | | |

| |Program Specifications Authorization Memorandum |

I have carefully assessed the Program Specifications for the (System Name). This document has been completed in accordance with the requirements of the HUD System Development Methodology.

MANAGEMENT CERTIFICATION - Please check the appropriate statement.

______ The document is accepted.

______ The document is accepted pending the changes noted.

______ The document is not accepted.

We fully accept the changes as needed improvements and authorize initiation of work to proceed. Based on our authority and judgment, the continued operation of this system is authorized.

_______________________________ _____________________

NAME DATE

Project Leader

_______________________________ _____________________

NAME DATE

Operations Division Director

_______________________________ _____________________

NAME DATE

Program Area/Sponsor Representative

_______________________________ _____________________

NAME DATE

Program Area/Sponsor Director

PROGRAM SPECIFICATIONS

TABLE OF CONTENTS

Page #

1.0 GENERAL INFORMATION 1-1

1.1 Purpose 1-1

1.2 Scope 1-1

1.3 System Overview 1-1

1.4 Project References 1-1

1.5 Acronyms and Abbreviations 1-1

1.6 Points of Contact 1-2

1.6.1 Information 1-2

1.6.2 Coordination 1-2

1.7 Master List of Programs 1-2

1.7.x [Program Identifier] 1-2

2.0 [PROGRAM IDENTIFIER] 2-1

2.1 Program Description 2-1

2.1.1 Software Unit Description 2-1

2.1.2 Software Unit 2-1

2.1.3 Accuracy and Validity 2-1

2.1.4 Timing 2-1

2.1.5 Adaptability 2-2

2.2 Environment 2-2

2.2.1 Support Software Environment 2-2

2.2.2 Interfaces 2-2

2.2.3 Storage 2-2

2.2.3.1 Internal Storage 2-3

2.2.3.2 Device Storage 2-3

2.2.3.3 Offline Storage 2-3

2.2.3.4 Temporary and Permanent Storage 2-3

2.2.4 Security 2-3

2.2.5 Communications Environment 2-3

2.3 Design Details 2-3

2.3.1 Input 2-3

2.3.1.1 Input Records 2-4

2.3.1.2 Input Data Elements 2-4

2.3.2 Output 2-4

2.3.2.1 Output Reports 2-5

2.3.2.2 Output Data Elements 2-5

2.3.3 Software Relationships 2-5

2.3.4 Software Unit Logic 2-6

1.0 GENERAL INFORMATION

NOTE TO AUTHOR: Highlighted, italicized text throughout this template is provided solely as background information to assist you in creating this document. Please delete all such text, as well as the instructions in each section, prior to submitting this document. ONLY YOUR PROJECT-SPECIFIC INFORMATION SHOULD APPEAR IN THE FINAL VERSION OF THIS DOCUMENT.

The Program Specifications expand on the requirements defined in the System/Subsystem Specifications. These guide the programming staff in the development of each program.

GENERAL INFORMATION

1.1 Purpose

Describe the purpose of the Program Specifications.

1.2 Scope

Describe the scope of the Program Specifications as it relates to the project.

1.3 System Overview

Provide a brief system overview description as a point of reference for the remainder of the document. In addition, include the following:

1. Responsible organization

2. System name or title

3. System code

4. System category

1. Major application: performs clearly defined functions for which there is a readily identifiable security consideration and need

2. General support system: provides general ADP or network support for a variety of users and applications

5. Operational status

3. Operational

4. Under development

5. Undergoing a major modification

6. System environment and special conditions

1.4 Project References

Provide a list of the references that were used in preparation of this document. Examples of references are:

7. Previously developed documents relating to the project

8. Documentation concerning related projects

9. HUD standard procedures documents

1.5 Acronyms and Abbreviations

Provide a list of the acronyms and abbreviations used in this document and the meaning of each.

1.6 Points of Contact

1.6.1 Information

Provide a list of the points of organizational contact (POCs) that may be needed by the document user for informational and troubleshooting purposes. Include type of contact, contact name, department, telephone number, and e-mail address (if applicable). Points of contact may include, but are not limited to, helpdesk POC, development/maintenance POC, and operations POC.

1.6.2 Coordination

Provide a list of organizations that require coordination between the project and its specific support function (e.g., installation coordination, security, etc.). Include a schedule for coordination activities.

1.7 Master List of Programs

This section provides a list and brief description of each program covered by these specifications. Each program should be under a separate section header, 1.7.1 - 1.7.x.

1.7.x [Program Identifier]

Provide a program name and identifier here for reference in the remainder of the section, along with a brief description. Programs 1.7.1 - 1.7.x will correspond sequentially to those described in sections 2.1 - 2.x.

2.0 [PROGRAM IDENTIFIER]

[PROGRAM IDENTIFIER]

This section provides a complete description for one program. Repeat this section for each program in the system, the next program being described in section 3.0, and so on. Each program (section) should correspond sequentially to the programs listed in sections 1.7.1-1.7.x. Note that the title page, header, and section name will have to be changed accordingly for each program described.

2.1 Program Description

Provide a brief description of the program.

2.1.1 Software Unit Description

Provide a description of the software unit and its significance within the system. The function should be taken from the corresponding sections of both the Functional Requirements Document and the System/Subsystem Specifications.

2.1.2 Software Unit

Describe the functions of the program and/or software units, as well as the relationship to each program. Although the descriptions of the functions must be refined and more detailed as a result of the continuing analysis and design, they must be directly related to the subsystem or system functions. The descriptions also must be stated in such a manner that the environment can be related to them.

2.1.3 Accuracy and Validity

Provide a description of accuracy requirements imposed on each software unit of the program.

2.1.4 Timing

Provide a description of the timing requirements imposed on each software unit of the program. For each software unit, include the following, repeating each unit as necessary:

|S/W Unit Name |

|Throughput time | |

|Response time to queries and to updates of data files | |

|Sequential relationship of program/software unit functions and data flow | |

|Priorities imposed by types of input and changes in modes of operation | |

|Timing requirements for the range of traffic load under varying operating | |

|conditions | |

|Sequencing or interaction of programs/software units within a system | |

|Input/Output transfer time required for disk, tape, etc. | |

|Internal processing time | |

2.1.5 Adaptability

Provide a description of the capability to be incorporated for adapting the program/software unit to changing requirements, such as anticipated operational changes, interaction with new or improved software, and planned periodic changes. Identify components and procedures that are designed to be subject to change.

2.2 Environment

This section specifies the environment in which the system will operate, indicating any changes made to the environment as reflected in the FRD and System/Subsystem Specifications.

2.2.1 Support Software Environment

Provide a description of the support software with which the system is to interact. Include support software, test software, and security software if needed. Provide the correct nomenclature and documentation references for each software system, subsystem, and program. Include references to the languages, the operating system, and any database management system to be used. If any of these components are not HUD-approved standards, indicate the date these items were approved for this project by the Configuration Change Management Board (CCMB).

2.2.2 Interfaces

Provide a description of the interfaces with other application software, including those of other operational capabilities and from other organizations. For each interface, specify the following information:

10. Type of interface, such as operator/terminal or interfaces with other software units

11. Description of operational implications of data transfer, including security considerations

12. Data transfer requirements to and from the software unit, including data content, format, and sequence

13. Formats of data for both the sending and receiving systems, including the data item names, codes, or abbreviations that are to be interchanged

14. Interface procedures

15. Interface equipment

16. Data conversion requirements

2.2.3 Storage

Provide a description of the software storage requirements for the program (software unit). Include the internal storage requirements; use of auxiliary storage such as tape, disk, or diskette; and the estimated quantity of permanent or temporary storage required for each medium. Differences between normal storage requirements and requirements for contingency operations shall be identified. For each storage medium, information such as the following should be provided.

2.2.3.1 Internal Storage

Describe and illustrate the use of internal storage areas, including indexing and working areas. Briefly state the equipment constraints and design considerations that affect the use of internal storage.

2.2.3.2 Device Storage

List by device type all peripheral storage required and any constraints imposed on storage requirements by each storage device. State requirements for permanent and temporary storage, including overlays.

2.2.3.3 Offline Storage

Describe the form, media, and storage requirements of all offline storage.

2.2.3.4 Temporary and Permanent Storage

Describe the allocation of storage into permanent and temporary areas.

2.2.4 Security

Describe the security classifications of the software.

2.2.5 Communications Environment

Describe or refer to an appendix that describes communications requirements for the programs/software units being documented.

2.3 Design Details

This section describes the design details of the software units comprising the system. If these details have been fully described in the Data Requirements Document, simply provide a reference here.

2.3.1 Input

Provide a detailed description of all input recorded. Where the information is available in a data element dictionary or database specification, refer to that document rather than include an extract. Examples of prepared input and input preparation forms may be included.

2.3.1.1 Input Records

Include the following for each input record, repeating the table for as many records as needed:

|Record Name |

|File name | |

|Format and type of data | |

|Validation criteria | |

|Sources, their media, and disposition | |

|Expected volume and frequency, including special handling | |

|Priority (routine, emergency) | |

|Security and privacy considerations | |

|Disposition other than processing, such as logging, hard copy reproduction| |

|of input, storage location, and custodial | |

|Flexibility, such as capability of omitting and adding items | |

|Requirements for timeliness | |

|Special processing | |

2.3.1.2 Input Data Elements

Include the following for each input data element, repeating the table for as many data elements as needed:

|Data Element Name |

|Name | |

|Position in the input record | |

|Synonymous names | |

|Definition | |

|Unit of measurement | |

|Format and acceptable range of values | |

|Security | |

|Data item names, abbreviations, and codes (specify which are used in the | |

|input) | |

Include examples of prepared input and preparation forms, such as input creation sheets and communications message forms.

2.3.2 Output

Provide a detailed description of all program (software units) output. If the information is available in a data element dictionary or database specification, refer to that document rather than include an extract. For each output type and its data elements, provide the following information.

2.3.2.1 Output Reports

|Data Element Name |

|Name | |

|Format (headings, line spacing, arrangement, totals, etc.). A report | |

|format sheet may be included. | |

|Output media (visual display unit, printer, etc.) | |

|Expected volume and frequency, including special handling/processing | |

|Selection criteria | |

|Priority (routine, emergency) | |

|Timing requirements (response time) | |

|User recipients and use of displays (notification, trends, briefings) | |

|Pre-printed form requirements | |

|Security and privacy considerations | |

|Disposition, including logging, film and hard copy reproduction and | |

|storage, number of copies required for distribution, place of storage, | |

|retention period, and special handling required because of bulk, security | |

|considerations, and timing. Refer to HUD Handbook 2229.1 Records | |

|Disposition Scheduling for Automated Systems for retention periods. | |

|Description of plots or graphic displays, including the coordinates to be | |

|used, explanation of symbols, type of graphic technique | |

|Conditional and status indicators (codes and definitions) | |

|Supporting background information | |

2.3.2.2 Output Data Elements

Include the following for each output data element, repeating the table for as many data elements as needed:

|Data Element Name |

|Name | |

|Synonymous names | |

|Definition | |

|Unit of measurement | |

|Format and acceptable range of values | |

|Security | |

|Data item names, abbreviations and codes (specify which are used in the | |

|output) | |

2.3.3 Software Relationships

Describe the interrelationships of the program (software unit) with the database to show how these files and tables are used in each function of the software.

2.3.4 Software Unit Logic

Describe the logic of each software unit in the program. Present the logical flow in graphical format showing the hierarchical arrangement of the software units and their interfaces. Supplement the graphic with pseudo-code and English language narrative explanations.

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download