Bureaucrats, confirmed, Administrators
4,558
edits
Changes
m
See 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://phpdocwww.mkdocs.org/ and 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.wikipediadrupal.org/wikiproject/Javadocuser_guide User Guide] documentation for Drupal 8
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.
* [http://svn.wikimedia.org/doc/ MediaWiki Doxygen docs]
== Tools / Generators / Examples ==[http://phpdoc.org/ phpDocumentor ] is the best documentation tool for PHP sources with inspiration from [[wp:Javadoc|JavaDoc]].
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.
== Documenting PHP Code ==
The main resource is the [http://www.phpdoc.org Project website], including tutorials and full Documentation. The system can be installed via the PEAR installer, but should not be setup in an Internet-facing environment. See the [[PhpDocumentor]] article for details on our installation and usage.
== Documenting JavaScript ==
JSDuck is an open source ExtJS 4 project developed at Sencha to help Javascript developers generate beautiful documentation viewable in a web browser. Based loosely on JavaDoc, JSDuck parses documentation embedded in the source files of your project enabling you to keep your docs close to your code. In this session we will cover the many features of JSDuck and by the end you will know how to create API documentation, guides, videos and examples for your own project or application.
* [https://vimeo.com/33465319 watch]
* Example: the MediaWiki project uses jsduck to generate https://doc.wikimedia.org/mediawiki-core/master/js/
* Example: https://docs.sencha.com/extjs/6.0.2-modern/
* More recently, Sencha has started using a custom documentation generator based on https://github.com/evindor/doxi <ref>https://www.sencha.com/forum/showthread.php?311056-documentation-system-to-use-for-ext-js-6.0.2-jsduck-still</ref>
== Documenting other languages ==
* http://www.open-emr.org/wiki/index.php/How_to_Document_Your_Code_Properly
{{References}}
[[Category:Help|Help]]
[[Category:Applications]]
[[Category:Help]]