User FAQ
TODO: Write a set of common questions and answers to help your users
use the product without needing technical support. Consider how the
sample questions and answers provided below relate to your product.
Add new questions and new sections to fit the needs of your users.
TIP: This FAQ is for end users, you may want to write a FAQ for
another type of stakeholder, such as potential customers, in-house
developers, partners in a developers' network, or administrators.
General Information
- What is PRODUCT-NAME?
- It is a TYPE-OF-PRODUCT with UNIQUE-FEATURES.
Please see our product
overview for more information.
- Who should use PRODUCT-NAME?
- Anyone who has TARGETED-NEEDS and wants
KEY-BENEFITS. PRODUCT-NAME is useful to TYPES-OF-USERS.
Download and Install
- How can I obtain PRODUCT-NAME?
- You may download PRODUCT-NAME.
- You may place
an order for PRODUCT-NAME.
- What do I need to use PRODUCT-NAME?
- System requirements are described in the release notes.
- System requirements are a Intel-compatible PC with a processor
speed of at least XXX MHz, XXX MB of RAM. XXX MB of free disk space,
and one of the following operating systems: Windows 98/2000/XP, Mac
OSX, Linux.
- How do I install PRODUCT-NAME?
- Installation instructions are available on-line.
- How do I upgrade from an older version of PRODUCT-NAME?
- Installation instructions are available on-line.
Getting Started
- What is TECHNICAL-TERM?
- It means DEFINITION-OF-TERM. For additional technical terms,
see the glossary.
- What is GUI-ELEMENT?
- It is a DESCRIPTION. It is used for GOAL.
- How do I do COMMON-TASK?
- You should understand CONTEXT-AND-PREREQUISITES. Once you are ready, you can:
- STEP
- STEP
- STEP
SECTION NAME
- QUESTION?
- ANSWER.
- QUESTION?
- ANSWER.
- QUESTION?
- ANSWER.
- QUESTION?
- ANSWER.
Troubleshooting
- I see an error message "ERROR-MESSAGE". What's wrong?
- DESCRIBE-CAUSE. DESCRIBE-CORRECTIVE-ACTIONS.
- I can't do COMMON-TASK. What's wrong?
- DESCRIBE-CAUSE. DESCRIBE-CORRECTIVE-ACTIONS.