User Guide

TODO: Fill in information on this product. Make sure to use the product name and external release number, not internal information.

Product Release Information

Product: PRODUCT-NAME
Release Number: X.Y.Z
Release Date: YYYY-MM-DD
Customer Support: For more information or support, please visit our website or email us at support@COMPANY.com

Table of Contents

TODO: Fill in the user guide outline below. Read the sample text below and consider how it applies to your product. Chip away unneeded sections and add new ones. Review the draft outline with potential users before starting to write body text.
TIP: Consider providing both tutorial (step-by-step) and reference material.

Many users refer to documentation only when:

  • They start using the product for the first time
  • They fail to accomplish some task with the product
  1. Introduction
    • What is PRODUCT-NAME?
    • About this user guide
  2. Tutorial
    • What is PROBLEM-DOMAIN?
    • Basic terms and concepts
    • Overview of PRODUCT-NAME
    • SAMPLE-PROBLEM-AND-SOLUTION-ONE
    • SAMPLE-PROBLEM-AND-SOLUTION-TWO
  3. Using PRODUCT-NAME
    • How to begin using PRODUCT-NAME
    • How to DO-COMMON-TASK
    • How to DO-COMMON-TASK
    • Tips on COMMON-TASKS
  4. Working with BUSINESS-OBJECTs
    • What is a BUSINESS-OBJECT?
    • Creating and Importing BUSINESS-OBJECTs
    • Searching and Browsing BUSINESS-OBJECTs
    • Editing BUSINESS-OBJECTs
    • Using the COMMAND-NAME command
    • Using the WINDOW-NAME window
    • Tips on BUSINESS-OBJECTs
  5. Advanced usage
    • ADVANCED-CONCEPT-ONE
    • ADVANCED-CONCEPT-TWO
    • Choosing between METHOD-A and METHOD-B
    • How FEATURE works
    • Working in ADVANCED-MODE
    • How to customize PRODUCT-NAME
    • How to DO-ADVANCED-TASK
    • How to DO-ADVANCED-TASK
    • Tips on ADVANCED-TASKS
  6. Administering PRODUCT-NAME
    • ADMIN-CONCEPT-ONE
    • ADMIN-CONCEPT-TWO
    • Configuring PRODUCT-NAME
    • How to DO-ADMIN-TASK
    • How to DO-ADMIN-TASK
    • Tips on ADMIN-TASKS
  7. Product Reference
    • Concept Reference
    • Command Reference
    • UI Reference
    • Configuration Option Reference
    • Error Message Reference
  8. CHAPTER-NAME
    • SECTION-NAME
    • SECTION-NAME
  9. Appendix A: Extended Example
    • EXAMPLE-SETTING
    • EXAMPLE-STEPS
    • ALTERNATIVE-STEPS
  10. Appendix B: Quick Reference
    • Keyboard shortcuts
    • Supported file types
    • Table of OBSCURE-CODES
    • Table of INPUT-SYNTAX
  11. Appendix C: Quick-Start for Users of LEGACY-SYSTEM
  12. Appendix D: Using PRODUCT-NAME with LEGACY-SYSTEM
  13. Appendix E: Lists of Figures, Tables, and Examples
  14. Glossary
  15. Index
TODO: Check for words of wisdom for additional advice on this template.
Company Proprietary
Copyright © 2003-2004 Method Labs. All rights reserved. License terms. Retain this copyright statement whenever this file is used as a template.