TODO: Fill in information on this product. Make sure to use the
product name and external release
number, not internal information.
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
- Introduction
- What is PRODUCT-NAME?
- About this user guide
- Tutorial
- What is PROBLEM-DOMAIN?
- Basic terms and concepts
- Overview of PRODUCT-NAME
- SAMPLE-PROBLEM-AND-SOLUTION-ONE
- SAMPLE-PROBLEM-AND-SOLUTION-TWO
- Using PRODUCT-NAME
- How to begin using PRODUCT-NAME
- How to DO-COMMON-TASK
- How to DO-COMMON-TASK
- Tips on COMMON-TASKS
- 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
- 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
- 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
- Product Reference
- Concept Reference
- Command Reference
- UI Reference
- Configuration Option Reference
- Error Message Reference
- CHAPTER-NAME
- SECTION-NAME
- SECTION-NAME
- Appendix A: Extended Example
- EXAMPLE-SETTING
- EXAMPLE-STEPS
- ALTERNATIVE-STEPS
- Appendix B: Quick Reference
- Keyboard shortcuts
- Supported file types
- Table of OBSCURE-CODES
- Table of INPUT-SYNTAX
- Appendix C: Quick-Start for Users of LEGACY-SYSTEM
- Appendix D: Using PRODUCT-NAME with LEGACY-SYSTEM
- Appendix E: Lists of Figures, Tables, and Examples
- Glossary
- Index