ReadySetGit/FAQ.md
William Sandner 154f9e132a fix GFM links
2018-08-14 17:55:05 +02:00

3.6 KiB

<html> <head> </head> Overview Project Plan Workflows Current <!-- Markdown content here --> <h1 id="user-content-user-faq" dir="auto">User FAQ</h1> <hr> <p dir="auto"><em>TODO: Answer these common questions. Some sample answers are provided for you. Add new questions and new sections to fit the needs of your users.</em></p> <p dir="auto"><em>TIP: This FAQ is for end users, you may want to write FAQ's for other types of stakeholders such as potential customers, open source contributors, members of a developers' network, or administrators.</em></p> <h3 id="user-content-general-information" dir="auto">General Information</h3> <h4 id="user-content-what-is-productname" dir="auto">What is ::PRODUCTNAME?</h4> <p dir="auto">::It is a XXXXX. Read our <a href="<a href="http://www.COMPANY.com/products/PRODUCTNAME/" class="link">http://www.COMPANY.com/products/PRODUCTNAME/</a>">PRODUCTNAME overview</a>.</p> <h4 id="user-content-who-should-use-productname" dir="auto">Who should use ::PRODUCTNAME?</h4> <p dir="auto">::Anyone who wants XXXXXXX. Read more about our <a href="/Suborbital-Systems/ReadySetGit/src/commit/154f9e132aa491957132617457cbabbb5072bcf8/Target-and-Benefits">target audience and benefits</a>.</p> <h3 id="user-content-download-and-install" dir="auto">Download and Install</h3> <h4 id="user-content-how-can-i-obtain-productname" dir="auto">How can I obtain ::PRODUCTNAME?</h4> <p dir="auto">::You may <a href="/Suborbital-Systems/ReadySetGit/src/commit/154f9e132aa491957132617457cbabbb5072bcf8/LINK-TO-DOWNLOAD">download PRODUCTNAME</a>.</p> <p dir="auto">::You may <a href="/Suborbital-Systems/ReadySetGit/src/commit/154f9e132aa491957132617457cbabbb5072bcf8/LINK-TO-ORDER">place an order for PRODUCTNAME</a>.</p> <h4 id="user-content-what-do-i-need-to-use-productname" dir="auto">What do I need to use ::PRODUCTNAME?</h4> <p dir="auto">::System requirements are described in the <a href="/Suborbital-Systems/ReadySetGit/src/commit/154f9e132aa491957132617457cbabbb5072bcf8/release-notes.html">release notes</a>.</p> <p dir="auto">::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.</p> <h4 id="user-content-how-do-i-install-productname" dir="auto">How do I install ::PRODUCTNAME?</h4> <p dir="auto">::<a href="/Suborbital-Systems/ReadySetGit/src/commit/154f9e132aa491957132617457cbabbb5072bcf8/install.html">Installation instructions</a> are available on-line.</p> <h4 id="user-content-how-do-i-upgrade-from-an-older-version-of-productname" dir="auto">How do I upgrade from an older version of PRODUCTNAME?</h4> <p dir="auto">::<a href="/Suborbital-Systems/ReadySetGit/src/commit/154f9e132aa491957132617457cbabbb5072bcf8/install.html">Installation instructions</a> are available on-line.</p> <h3 id="user-content-getting-started" dir="auto">Getting Started</h3> <h4 id="user-content-what-is-technical-term" dir="auto">What is ::TECHNICAL-TERM?</h4> <p dir="auto">::It means XXXXX. For additional technical terms, see the <a href="/Suborbital-Systems/ReadySetGit/src/commit/154f9e132aa491957132617457cbabbb5072bcf8/Glossary">glossary</a>.</p> <h4 id="user-content-what-is-gui-element" dir="auto">What is ::GUI-ELEMENT?</h4> <p dir="auto">::It is a XXXXX. It is used for YYYYY.</p> <h4 id="user-content-how-do-i-do-common-task" dir="auto">How do I do ::COMMON-TASK?</h4> <p dir="auto">::You should understand that XXX. Once you are ready, you can:</p> <ol dir="auto"> <li>::Step one</li> <li>::Step two</li> <li>::Step three</li> </ol> <h3 id="user-content-section-name" dir="auto">SECTION NAME</h3> <h4 id="user-content-question" dir="auto">::QUESTION?</h4> <p dir="auto">::ANSWER.</p> <h4 id="user-content-question-1" dir="auto">::QUESTION?</h4> <p dir="auto">::ANSWER.</p> <h4 id="user-content-question-2" dir="auto">::QUESTION?</h4> <p dir="auto">::ANSWER.</p> <h4 id="user-content-question-3" dir="auto">::QUESTION?</h4> <p dir="auto">::ANSWER.</p> <h3 id="user-content-troubleshooting" dir="auto">Troubleshooting</h3> <h4 id="user-content-i-see-an-error-message-error-message-whats-wrong" dir="auto">::I see an error message &quot;ERROR-MESSAGE&quot;. What's wrong?</h4> <p dir="auto">::ANSWER.</p> <h4 id="user-content-i-cant-do-common-task-whats-wrong" dir="auto">::I can't do COMMON-TASK. What's wrong?</h4> <p dir="auto">::ANSWER.</p> <h3 id="user-content-other-questions" dir="auto">Other Questions</h3> <h4 id="user-content-my-question-is-not-on-this-page-how-do-i-find-the-answer" dir="auto">::My question is not on this page. How do I find the answer?</h4> <p dir="auto">:: First read the <a href="/Suborbital-Systems/ReadySetGit/src/commit/154f9e132aa491957132617457cbabbb5072bcf8/user-guide">user guide</a> and other on-line help. Your question may have already been asked and answered, to find it: search the project <a href="#user-content-">mail archives</a> and <a href="#user-content-">issue tracking system</a>. If you still don't find it, you can ask the question on the <a href="#user-content-">users' mailing list</a> or the <a href="#user-content-">developers' mailing list</a> or you can <a href="#user-content-">enter an issue</a>.</p> <h4 id="user-content-where-should-i-send-comments-on-this-faq" dir="auto">::Where should I send comments on this FAQ?</h4> <p dir="auto">:: You can write to <a href="mailto:#">EMAIL-ADDRESS</a> or any of the developers on the <a href="mailto:#">developers' mailing list</a>.</p> <!-- End Markdown content -->
</html>