Actions

Documentation Working Group

Other languages:
English 100% • ‎español 100% • ‎français 100% • ‎Bahasa Indonesia 100% • ‎Nederlands 100% • ‎русский 100%


Documentation all together large.jpg

The Documentation Working Group

The Documentation Working Group is part of the Production Department. It is responsible for creating and maintaining all the official Joomla! documentation including that for end-users, administrators and third-party developers as well as the Help Screens served in the backend of Joomla! websites.

  • Team Leader: Sandra Thevenet
  • Assistant Team Leader: Tom Hutchison

Documentation SubTeams

Documentation Helpscreen Team

The Documentation Helpscreen Team is in charge of maintaining and updating the help screens for the Joomla! releases.

  • Team Leader: Tom Hutchison
  • Assistant Team Leader: Martijn Maandag

Documentation Translation Team

The official documentation language is British English. Translations of the official documentation into other languages are the responsibility of the Documentation Translation Team (JDT).

  • Team Leader: Martijn Maandag
  • Assistant Team Leader: Sandra Thevenet

en-GB User Interface Text Working Group

The Joomla! en-GB User Interface Text Guidelines is in charge of establishing and maintaining the official style guidelines for writing en-GB strings, as well as ensuring consistency throughout Joomla.

  • Team Leader: Hugh Douglas-Smith

Joomla! Documentation Wiki

The bulk of the documentation effort now revolves around this wiki.

Internal References

  • List of local wiki templates that can be used in your wiki pages. Templates reduce repetition and are the basis of modular documentation.
  • List of local wiki extensions that have been installed on this wiki. Extensions provide additionally functionality to the wiki such as syntax highlighting and conditional expressions.
  • List of local interwiki links that are available on this wiki. These provide useful shortcuts to creating URLs to other websites including the Joomla! forum, help screens and issue tracker; as well as links to the PHP documentation or Wikipedia.

All Documentation 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. 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

Joomla! help screens are created on this wiki before being served in the backend of any Joomla! website through the Help server.

Other Public Resources

Advertisement