Introduction It is difficult to provide a users’ guide template that fits all situations since applications vary so much in what they allow users to do. This template is put forth for the project manager or other writer to use in tailoring to the specific characteristics of the software and the project. Purpose Describe the purpose of the guide, which is typically to familiarize users with the important features and navigational elements of the tool. Overview Explain in general terms the system and the purpose for which it is intended. The description may include some of the following elements: List and describe the major functions performed by the system Describe the architecture of the system in non-technical terms, (e.g., client/server, 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 support system: provides general computing 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 conditions Project References Provide a list of the references that were used in preparation of this document in order of importance to the end user. 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: help desk POC, development/maintenance POC, and operations POC.
Introduction It is difficult to provide a users’ guide template that fits all situations since applications vary so much in what they allow users to do. This template is put forth for the project manager or other writer to use in tailoring to the specific characteristics of the software and the project. Purpose Describe the purpose of the guide, which is typically to familiarize users with the important features and navigational elements of the tool. Overview Explain in general terms the system and the purpose for which it is intended. The description may include some of the following elements: List and describe the major functions performed by the system Describe the architecture of the system in non-technical terms, (e.g., client/server, 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 support system: provides general computing 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 conditions Project References Provide a list of the references that were used in preparation of this document in order of importance to the end user. 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: help desk POC, development/maintenance POC, and operations POC.
mobile-app-user-guide-template.docx