User Manuals: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
Line 12: Line 12:
===Content===
===Content===
* Should provide thorough instructions and answers on how to use OpenPetra effectively.
* Should provide thorough instructions and answers on how to use OpenPetra effectively.
===Format===
* A separate User Guide for each of the OpenPetra Modules should be created.
* A 'General User Guide' for a general introduction to OpenPetra should be created.


===Portable===
===Portable===

Revision as of 05:37, 29 Haziran 2019

Overview

At this point in time, there are no comprehensive User Guides for OpenPetra users available.

Current Options


See Application Help for another form of documentation for OpenPetra.

Goals of OpenPetra User Guides

Content

  • Should provide thorough instructions and answers on how to use OpenPetra effectively.

Portable

  • User Guides should be viewable on any operating system. This goal could be reached by providing the User Guides in PDF format.


Authoring of User Guides

Using Sphinx

The plan is to write the content of the User Guides with Sphinx, store them in Github, and publish them at https://docs.openpetra.org/. Sphinx also allows to produce PDF files.

See https://docs.openpetra.org/contributions/index.html for more details!

Possible Alternative: FLOSS Manuals

See FLOSS Manuals