Descriptivo

USER’S

MANUAL

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 | User’s Manual Template and Checklist |
Rev. 1 | 4/10/02 | Conversion to WORD 2000 format |
| | |
| | |
| | |
| | |
| | |


| User’s Manual Authorization Memorandum |I have carefully assessed the User’s Manual 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 notaccepted.
-------------------------------------------------


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

USER'S MANUAL

TABLE OF CONTENTS

Page #

1.0 GENERAL INFORMATION
1.1 System Overview
1.2 Project References1.3 Authorized Use Permission
1.4 Points of Contact
1.4.1 Information
1.4.2 Coordination
1.4.3 Help Desk
1.5 Organization of the Manual
1.6 Acronyms and Abbreviations
2.0 SYSTEM SUMMARY
2.1 System Configuration
2.2 Data Flows
2.3 User Access Levels
2.4 Contingencies and Alternate Modes of Operation
3.0 GETTING STARTED
3.1 Logging On
3.2 System Menu3.2.x [System Function Name]
3.3 Changing User ID and Password
3.4 Exit System
4.0 USING THE SYSTEM (ONLINE)
4.x [System Function Name]
4.x.y [System Sub-Function Name]
4.2 Special Instructions for Error Correction
4.3 Caveats and Exceptions
5.0 USING THE SYSTEM (BATCH)
5.x [System Function Name]
5.x.y [System Sub-Function Name]
5.2 Special Instructions for ErrorCorrection
5.3 Caveats and Exceptions
5.4 Input Procedures and Expected Output

6.0 QUERYING
6.1 Query Capabilities
6.2 Query Procedures
7.0 REPORTING
7.1 Report Capabilities
7.2 Report Procedures


1.0 GENERAL INFORMATION

NOTE TO AUTHOR: highlighted, italicized text throughout this template is provided solely as background information to assist you in creating thisdocument. 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 User’s Manual provides the information necessary for the user to effectively use the automated information system.

GENERAL INFORMATION

1.1 System Overview

Explain ingeneral terms the system and the purpose for which it is intended. The description shall include:

0 Major functions performed by the system
1 Describe the architecture of the system in non-technical terms, (e.g., client/server, Web-based, etc.)
2 User access mode, (e.g., graphical user interface)
3 Responsible organization
4 System name or title
5 System code
6 Systemcategory:
0 Major application: performs clearly defined functions for which there is a readily identifiable security consideration and need
1 General support system: provides general ADP or network support for a variety of users and applications
7 Operational status:
2 Operational
3 Under development
4 Undergoing a major modification
8 General description
9...