用户手册英文模板 user manual template.docx

1、用户手册英文模板 user manual templateUSERSMANUALProject or System NameU.S. Department of Housing and Urban DevelopmentMonth, YearRevision SheetRelease No.DateRevision DescriptionRev. 05/30/00Users Manual Template and ChecklistRev. 14/10/02Conversion to WORD 2000 formatUsers Manual Authorization MemorandumI

2、have carefully assessed the Users 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 pendi

3、ng 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 Dire

4、ctor_ _NAME DATEProgram Area/Sponsor Representative_ _NAME DATEProgram Area/Sponsor DirectorUSERS MANUALTABLE OF CONTENTSPage #1.0 GENERAL INFORMATIONNOTE TO AUTHOR: highlighted, italicized text throughout this template is provided solely as background information to assist you in creating this docu

5、ment. 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 Users Manual provides the information necessary for the user to effectively use the automa

6、ted information system.1.0GENERAL 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 systemDescribe the architecture of the system in non-technical terms, (e.g., client/server, We

7、b-based, etc.)User access mode, (e.g., graphical user interface)Responsible organizationSystem name or titleSystem codeSystem category:-Major application: performs clearly defined functions for which there is a readily identifiable security consideration and need-General support system: provides gen

8、eral ADP or network support for a variety of users and applicationsOperational status:-Operational-Under development-Undergoing a major modificationGeneral descriptionSystem environment or special conditions1.2 Project ReferencesProvide a list of the references that were used in preparation of this

9、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 proce

10、ss.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). Poin

11、ts 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.). Inclu

12、de a schedule for coordination activities.1.4.3 Help DeskProvide help desk information including responsible personnel phone numbers for emergency assistance.1.5 Organization of the ManualProvide a list of the major sections of the Users Manual (1.0, 2.0, 3.0, etc.) and a brief description of what i

13、s contained in each section.1.6 Acronyms and AbbreviationsProvide a list of the acronyms and abbreviations used in this document and the meaning of each.2.0 SYSTEM SUMMARY2.0SYSTEM SUMMARYThis section provides a general overview of the system written in non-technical terminology. The summary should

14、outline the uses of the system in supporting the activities of the user and staff.2.1 System ConfigurationBriefly describe and depict graphically the equipment, communications, and networks used by the system. Include the type of computer input and output devices.2.2 Data FlowsBriefly describe or de

15、pict graphically, the overall flow of data in the system. Include a user-oriented description of the method used to store and maintain data.2.3 User Access LevelsDescribe the different users and/or user groups and the restrictions placed on system accessibility or use for each.2.4 Contingencies and

16、Alternate Modes of OperationOn a high level, explain the continuity of operations in the event of emergency, disaster, or accident. Explain what the effect of degraded performance will have on the user.3.0 GETTING STARTED3.0GETTING STARTEDThis section provides a general walkthrough of the system fro

17、m initiation through exit. The logical arrangement of the information shall enable the functional personnel to understand the sequence and flow of the system. Use screen prints to depict examples of text under each heading.3.1 Logging OnDescribe the procedures necessary to access the system, includi

18、ng how to get a user ID and log on. If applicable, identify job request forms or control statements and the input, frequency, reason, origin, and medium for each type of output.3.2 System MenuThis section describes in general terms the system menu first encountered by the user, as well as the naviga

19、tion paths to functions noted on the screen. Each system function should be under a separate section header, 3.2.1 - 3.2.x.3.2.x System Function NameProvide a system function name and identifier here for reference in the remainder of the subsection. Describe the function and pathway of the menu item

20、. Provide an average response time to use the function.3.3 Changing User ID and PasswordDescribe how the user changes a user ID. Describe the actions a user must take to change a password.3.4 Exit SystemDescribe the actions necessary to properly exit the system.4.0 USING THE SYSTEM (ONLINE)This sect

21、ion provides a detailed description of the online system from initiation through exit, explaining in detail the characteristics of the required input and system-produced output. THIS SECTION IS ONLY TO BE USED FOR ONLINE SYSTEMS. IF YOU ARE DEVELOPING A BATCH SYSTEM, USE SECTION 5.0 AND OMIT THIS SE

22、CTION ENTIRELY.4.0USING the SYSTEM (ONline)This section provides a detailed description of system functions. Each function should be under a separate section header, 4.1 - 4.x, and should correspond sequentially to the system functions (menu items) listed in subsections 3.2.1 - 3.2.x.4.x System Func

23、tion NameProvide a system function name and identifier here for reference in the remainder of the subsection. Describe the function in detail and depict graphically. Include screen captures and descriptive narrative.4.x.y System Sub-Function NameThis subsection provides a detailed description of sys

24、tem sub-functions. Each sub-function should be under a separate section header, 4.1.1. - 4.x.y . Where applicable, for each sub-function referenced within a section in 4.x, describe in detail and depict graphically the sub-function name(s) referenced. Include screen captures and descriptive narrativ

25、e.The numbering of the following two sections will depend on how many system functions there are from 4.1 through 4.x. They are numbered here as 4.2 and 4.3 only for the sake of convenience. For example, if system functions run from sections 4.1 through 4.17, then the following two sections would be

26、 numbered 4.18 and 4.19.4.2 Special Instructions for Error CorrectionDescribe all recovery and error correction procedures, including error conditions that may be generated and corrective actions that may need to be taken.4.3 Caveats and ExceptionsIf there are special actions the user must take to i

27、nsure that data is properly saved or that some other function executes properly, describe those actions here. Include screen captures and descriptive narratives, if applicable.5.0 USING THE SYSTEM (BATCH)This section provides a detailed description of the batch system from initiation through exit, e

28、xplaining in detail the characteristics of the required input and system-produced output. THIS SECTION IS ONLY TO BE USED FOR BATCH SYSTEMS. IF YOU ARE DEVELOPING AN ONLINE SYSTEM, USE SECTION 4.0 AND OMIT THIS SECTION ENTIRELY.5.0USING the SYSTEM (batch)This section provides a detailed description

29、of system functions. Each function should be under a separate section header, 5.1 - 5.x, and should correspond sequentially to the system functions (menu items) listed in subsections 3.2.1 - 3.2.x.5.x System Function NameProvide a system function name and identifier here for reference in the remaind

30、er of the subsection. Describe the function in detail and depict graphically. Include screen captures and descriptive narrative.5.x.y System Sub-Function NameThis subsection provides a detailed description of system sub-functions. Each sub-function should be under a separate section header, 5.1.1 -

31、5.x.y. Where applicable, for each sub-function referenced within a section in 5.x, describe in detail and depict graphically the sub-function name(s) referenced. Include screen captures and descriptive narrative.The numbering of the following three sections will depend on how many system functions there are from 5.1 through 5.x. They are numbered here as 5.2, 5.3, and 5.4 only for the sake of convenience. For example, if system functions run from secti