Actions

Difference between revisions of "Documentation Working Group"

From Joomla! Documentation

m (Added Doc WG category)
Line 1: Line 1:
 
The Documentation Working Group is responsible for creating and maintaining all the official Joomla! documentation including that for end-users, administrators and third-party developers.  We also maintain the help screens for the Joomla! releases.
 
The Documentation Working Group is responsible for creating and maintaining all the official Joomla! documentation including that for end-users, administrators and third-party developers.  We also maintain the help screens for the Joomla! releases.
  
The official documentation language is British/Australian.  Translations of the official documentation into other languages are the responsibility of the [[Translation Working Group]].
+
The official documentation language is British/Australian.  Translations of the official documentation into other languages are the responsibility of the [[Translations Working Group]].
  
 
==Websites==
 
==Websites==

Revision as of 02:14, 11 April 2008

The Documentation Working Group is responsible for creating and maintaining all the official Joomla! documentation including that for end-users, administrators and third-party developers. We also maintain the help screens for the Joomla! releases.

The official documentation language is British/Australian. Translations of the official documentation into other languages are the responsibility of the Translations Working Group.

Websites

The Documentation Working Group currently maintains the following websites:

api.joomla.org
This entire site is automatically generated by the phpDocumentor package from an analysis of the Joomla! source code and making use of specially formatted comments embedded in the source code itself. It is an invaluable tool for all Joomla! developers.
docs.joomla.org

The concept behind docs.joomla.org is that it will become the central resource for developing single-source modular documentation within the Joomla! project. The idea is that we write stuff once then re-use it in a somewhat analogous way to modern OOP software development. In the future we expect that other sites, such as help.joomla.org and developer.joomla.org will contain some, or even most, of their content derived from sources here. By building a central database of document "chunks" we gain maximum benefit from the efforts of a limited number of authors and we produce "agile" documents where a single change is rapidly propagated to all the derived documents affected.

Those interested in the techniques will find more information here.

help.joomla.org
The official help site houses much of our early documentation, including that for Joomla! 1.0.x, the help screens for all Joomla! versions and the Joomla! 1.5 Installation Guide.

Other public resources