User Guide Checklist

Use this checklist to write your User Guide. The checklist will help reviewers determine if the specifications meet the quality criteria and comply with development methodology requirements.

Download 4 MS Word User Guide Templates

General Information

  • System Overview – introduce the system at a high-level and its relationship to others, if necessary.
  • References – list reference materials used in preparation of this document.
  • Use Permission – provide warnings regarding unauthorized usage of the system and making unauthorized copies of data, software, reports, and documents, if applicable.
  • Points of Contact – identify the contacts that may be needed for informational and troubleshooting purposes.
  • Coordination – list any organizations or groups that require coordination between the project and its support function. Include a schedule for coordination activities.
  • Help Desk – provide email and phone numbers for emergency assistance
  • Organization of the User Guide – outline the major sections of the User Guide with a brief description of each section.
  • Acronyms and Abbreviations – list and describe the acronyms and abbreviations used in this document.
  • System Configuration – describe and depict graphically the equipment, communications, and networks used by the system.
  • Data Flows – describe or depict graphically, the overall flow of data in the system.
  • User Access Levels – describe the different users and/or user groups and the restrictions placed on system accessibility or use for each.
  • Contingencies – describe the continuity of operations in the event of emergency, disaster, or accident.  Explain what the effect of degraded performance will have on the user.
  • Logging On – describe the procedures to access the system.
  • System Menu – identify each system function under a separate header. Generate new subsections as necessary for each system function.
  • Provide a system function name and identifier here for reference in the remainder of the subsection.
  • Describe the menu items.
  • Log off and Exit System – describe the procedure to exit the system.

System Summary

Batch Processing

If relevant, describe each system function under a separate header.

  • Provide a system function name and identifier for reference in the remainder of the subsection
  • Describe the function with accompanying screenshots
  • Generate new subsections as necessary for each system sub-function
  • Describe all recovery and error correction procedures
  • Describe error conditions and corrective actions
  • Describe special actions the user must take to insure data is saved or procedures are executed properly

Input Procedures and Expected Output

Describing inputs procedures and expected outputs.

Querys

  • Describe ad hoc query capabilities provided by the system. Include query name or code the user would invoke to execute the query.
  • Develop detailed descriptions of the procedures necessary for file query including the parameters of the query and the sequenced control instructions to extract query requests from the database.
  • Describe all reports available to the end user.  If user is creating ad hoc reports with special formats, please describe here.
  • Provide instructions for executing and printing the different reports available.

Download 4 MS Word User Guide Templates

Download these templates to start

Acceptance Test Plan

Contingency Plan

Software Development Templates

Acquisition Plan

Conversion Plan

Software Requirements Specification

Action Plan

Cost Benefit Analysis

Software Testing

API Documentation

Database Design

Standard Operating Procedures (SOP)

Audience Analysis

Datasheet

Statement of Work

Availability Plan

Deployment Plan

System Administration Guide

Bill of Materials

Design Document

System Boundary

Business Case

Disaster Recovery Plan

System Design Document

Business Continuity

Disposition Plan

System Specifications

Business Plan

Documentation Plan

Technical Writing Templates

Business Process

Employee Handbook

Test Plan

Business Requirements

Error Message Guide

Training Plan

Business Rules

Expression of Interest

Transition Plan

Capacity Plan

Fact Sheet

Troubleshooting Guide

Case Study

Feasibility Study

Use Case

Change Management Plan

Functional Requirements

User Guide

Communication Plan

Grant Proposal

Verification and Validation Plan

Concept of Operations

Implementation Plan

White Papers

Concept Proposal

Installation Plan

Work Instructions

Configuration Management Plan

Interface Control Document

Software Development Templates

Acceptance Test Plan

Maintenance Plan

Software Requirements Specification

Acquisition Plan

Market Research

Software Testing

Action Plan

Marketing Plan

Standard Operating Procedures (SOP)

API Documentation

Needs Statement

Statement of Work

Audience Analysis

Operations Guide

System Administration Guide

Availability Plan

Policy Manual

System Boundary

Bill of Materials

Project Plan

System Design Document

Business Case

Proposal Manager Templates

System Specifications

Business Continuity

Proposal Template

Technical Writing Templates

Business Plan

Quality Assurance Plan

Test Plan

Business Process

Release Notes

Training Plan

Business Requirements

Request for Proposal

Transition Plan

Business Rules

Risk Management Plan

Troubleshooting Guide

Capacity Plan

Scope of Work

Use Case

Case Study

Security Plan

User Guide

Change Management Plan

Service Level Agreement (SLA)

Verification and Validation Plan

Communication Plan

Setup Guide

White Papers

Concept of Operations

Social Media Policy

Work Instructions

Concept Proposal

Contingency Plan

 

Configuration Management Plan

Conversion Plan