2023-03-24 16:29:16 +00:00
|
|
|
<!-- markdownlint-disable-next-line first-line-h1 -->
|
|
|
|
|
|
|
|
_TODO: Answer these common questions. Some sample answers are provided
|
2018-08-14 12:48:17 +00:00
|
|
|
for you. Add new questions and new sections to fit the needs of your
|
2023-03-24 16:29:16 +00:00
|
|
|
users._
|
2018-08-14 12:48:17 +00:00
|
|
|
|
2023-03-24 16:29:16 +00:00
|
|
|
_TIP: This FAQ is for end users, you may want to write FAQ's for other
|
2018-08-14 12:48:17 +00:00
|
|
|
types of stakeholders such as potential customers, open source
|
2023-03-24 16:29:16 +00:00
|
|
|
contributors, members of a developers' network, or administrators._
|
2018-08-14 12:48:17 +00:00
|
|
|
|
|
|
|
### General Information
|
2018-08-14 15:55:05 +00:00
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
#### What is ::PRODUCT-NAME?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
::It is a XXXXX. Read our [PRODUCT-NAME overview](http://www.COMPANY.com/products/PRODUCT-NAME/).
|
2018-08-14 12:48:17 +00:00
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
#### Who should use ::PRODUCT-NAME?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
::Anyone who wants XXXXXXX. Read more about our [target audience and benefits](Target-and-Benefits).
|
2018-08-14 12:48:17 +00:00
|
|
|
|
|
|
|
### Download and Install
|
2018-08-14 15:55:05 +00:00
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
#### How can I obtain ::PRODUCT-NAME?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
::You may [download PRODUCT-NAME](LINK-TO-DOWNLOAD).
|
2018-08-14 12:48:17 +00:00
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
::You may [place an order for PRODUCT-NAME](LINK-TO-ORDER).
|
2018-08-14 12:48:17 +00:00
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
#### What do I need to use ::PRODUCT-NAME?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
|
|
|
::System requirements are described in the [release notes](Release-Notes).
|
2018-08-14 12:48:17 +00:00
|
|
|
|
|
|
|
::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.
|
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
#### How do I install ::PRODUCT-NAME?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::[Installation instructions](install.html) are available on-line.
|
|
|
|
|
2018-08-23 17:23:45 +00:00
|
|
|
#### How do I upgrade from an older version of PRODUCT-NAME?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::[Installation instructions](install.html) are available on-line.
|
|
|
|
|
|
|
|
### Getting Started
|
2018-08-14 15:55:05 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
#### What is ::TECHNICAL-TERM?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::It means XXXXX. For additional technical terms, see the
|
2018-08-14 15:55:05 +00:00
|
|
|
[glossary](Glossary).
|
2018-08-14 12:48:17 +00:00
|
|
|
|
|
|
|
#### What is ::GUI-ELEMENT?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::It is a XXXXX. It is used for YYYYY.
|
|
|
|
|
|
|
|
#### How do I do ::COMMON-TASK?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::You should understand that XXX. Once you are ready, you can:
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
1. ::Step one
|
|
|
|
2. ::Step two
|
|
|
|
3. ::Step three
|
|
|
|
|
|
|
|
### SECTION NAME
|
2018-08-14 15:55:05 +00:00
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
#### ::QUESTION-1?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::ANSWER.
|
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
#### ::QUESTION-2?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::ANSWER.
|
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
#### ::QUESTION-3?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::ANSWER.
|
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
#### ::QUESTION-4?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::ANSWER.
|
|
|
|
|
|
|
|
### Troubleshooting
|
2018-08-14 15:55:05 +00:00
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
#### I see an error message "::ERROR-MESSAGE". What's wrong?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::ANSWER.
|
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
#### I can't do ::COMMON-TASK. What's wrong?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
2018-08-14 12:48:17 +00:00
|
|
|
::ANSWER.
|
|
|
|
|
|
|
|
### Other Questions
|
2018-08-14 15:55:05 +00:00
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
#### My question is not on this page. How do I find the answer?
|
2018-08-14 17:39:17 +00:00
|
|
|
|
|
|
|
::First read the [user guide](user-guide) and other
|
2018-08-14 12:48:17 +00:00
|
|
|
on-line help. Your question may have already been asked and
|
2021-08-01 12:37:39 +00:00
|
|
|
answered, to find it: search the project [mail archives](::tbd) and
|
|
|
|
[issue tracking system](::tbd). If you still don't find it, you can ask
|
|
|
|
the question on the [users' mailing list](::tbd) or the [developers'
|
|
|
|
mailing list](::tbd) or you can [enter an issue](::tbd).
|
2018-08-14 12:48:17 +00:00
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
#### Where should I send comments on this FAQ?
|
2018-08-14 12:48:17 +00:00
|
|
|
|
2021-08-01 12:37:39 +00:00
|
|
|
::You can write to [EMAIL-ADDRESS](::mailto:#) or any of the developers
|
|
|
|
on the [developers' mailing list](::mailto:#).
|