Bureaucrats, confirmed, Administrators
4,558
edits
Changes
m
link to new article
## installing the software
## using the software in the most common use-cases with examples, illustrations, or videos
### On this last point, a special name for the "User Manual", especially when integrated into the user interface of the software, is "Help". Because systems may be aggregates of several pieces of software, there is often a need for "Help" that addresses how the underlying software is aggregated into that particular system. A perfect example is a wiki (like this one) that includes many 'extensions' to provide specific functionality in addition to what the core software does; and local [[Category:Help|Help]].
# "API Docs" is a special nuance of Documentation. If your software includes an [[API]], then that API needs to be fully documented almost as a separate piece of software -- for both developers of the API and users of the API.
The PyDoc tool is used to generate documentation on the language itself, and is also leveraged as a framework for developers of help systems and obviously used to document any classes, and methods of source code.
The [[CiviCRM]] project, which originally used the Atlassian Confluence Wiki product for documentation, moved over to the (better) '''Read The Docs''' system<ref>https://civicrm.org/blog/michael-mcandrew/a-new-home-for-our-documentation</ref> (based on markdown) in a [https://github.com/civicrm/civicrm-user-guide github repository] and uses the [http://www.mkdocs.org/ MkDocs] (BSD) [[static site generator ]] tool to publish to their own domain http://docs.civicrm.org/user/en/4.6/
Meanwhile, the [[Drupal]] project has a [https://www.drupal.org/governance/doc-working-group Documentation Working Group] who is using [http://www.methods.co.nz/asciidoc/ AsciiDoc] (GPL) to do the [https://www.drupal.org/project/user_guide User Guide] documentation for Drupal 8
{{References}}
[[Category:Help|Help]]
[[Category:Applications]]
[[Category:Help]]