Documentation Overview
From GnuCash
The GnuCash Project contains several kinds of Documentation. This pages explains the differences.
- Targets
- Where should users search first?
- Where should contributors add information?
Integrated Documents
They are the content of our GitHub repository gnucash-docs, are usually shipped together with the program and accessible by its Help menu.
- Note
- Some distributions split them in a separate package "gnucash-doc" or similar. Then users should install it to have easier access.
- Pros
- Accessible without internet.
- Cons
- Sometimes partially outdated.
The Gnucash-docs consist of two parts:
- gnucash-help
- is the reference manual describing the GUI elements and their relations.
- gnucash-guide
- contains the tutorial and the concepts guide. Here you can
- learn our terminology and
- the steps to resolve specific tasks.
- Contributors
-
- Requirement
- Dokbook knowledge
- Target
- Finally all important documentation should end here!
Online Documents
- Pros
- Sometimes more recent.
- Cons
- Internet required.
Wiki
The wiki has (often more recent)
- Thematic pages
- sometimes in several languages
- The FAQ
- a catch all starting point. But if there are 2 or more questions about the same theme, the content should go into a dedicated page, leaving only links in the FAQ.
- You can either Special:Search or navigate by Special:Categories.
- Contributors
- Only MediaWiki Markup required, for examples see Wiki_Tips.
Website
The current use is mainly
- [[[:Template:WebURL]]/news.phtml announcements] and
- (linking) downloads of
- [[[:Template:WebURL]]/download.phtml program] or
- [[[:Template:WebURL]]/docs.phtml documentation].
- [[[:Template:WebURL]]/features.phtml features] shows still GnuCash 2.
- [[[:Template:WebURL]]/sizing.phtml sizing] is a Y2K hommage.
- Contributors
-
- Requirements
- PHP+HTML
- Targets
- mostly marketing
Lists
Archives of the Mailing Lists and IRC logs are available, but usually only a short time relevant and harder to search.
Other
- Social Media
- see Website header
- Contributors
- volunteering?
