用户标准手册英文模板usermanualtemplate.docx

USER’SMANUALProject or System NameU.S. Department of Housing and Urban DevelopmentMonth, YearRevision SheetRelease No.DateRevision DescriptionRev. 05/30/00User’s Manual Template and ChecklistRev. 14/10/02Conversion to WORD formatUser’s Manual Authorization MemorandumI 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 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 DATEProject Leader_______________________________ _____________________NAME DATEOperations Division Director_______________________________ _____________________NAME DATEProgram Area/Sponsor Representative_______________________________ _____________________NAME DATEProgram Area/Sponsor DirectorUSER'S MANUALTABLE OF CONTENTSPage #1.0 GENERAL INFORMATION 1.1 System Overview 1.2 Project References 1.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 Menu 3.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 Error Correction 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 INFORMATIONNOTE 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 User’s Manual provides the information necessary for the user to effectively use the automated information system.1.0 GENERAL INFORMATION1.1 System OverviewExplain in general terms the system and the purpose for which it is intended. The description shall include: · Major functions performed by the system· Describe the architecture of the system in non-technical terms, (e.g., client/server, Web-based, etc.)· User access mode, (e.g., graphical user interface)· Responsible organization· System name or title· System code· System category:- Major application: performs clearly defined functions for which there is a readily identifiable security consideration and need- General support system: provides general ADP or network support for a variety of users and applications· Operational status:- Operational- Under development- Undergoing a major modification· General description· System environment or special conditions1.2 Project ReferencesProvide a list of the references that were used in preparation of this document in order of importance to the end user.1.3 Authorized Use PermissionProvide a warning regarding unauthorized usage of the system and making unauthorized copies of data, software, reports, and documents, if applicable. If waiver use or copy permissions need to be obtained, describe the process.1.4 Points of Contact1.4.1 InformationProvide 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, help desk POC, development/maintenance POC, and operations POC.1.4.2 CoordinationProvide 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.4.3 Help DeskProvide help。