Actions

Difference between revisions of "Documentation Working Group"

From Joomla! Documentation

(Other public resources)
Line 24: Line 24:
 
* [http://groups.google.com/group/joomla-docs Documentation Working Group mailing list]
 
* [http://groups.google.com/group/joomla-docs Documentation Working Group mailing list]
 
* [http://groups.google.com/group/joomla-devel-docs Developer documentation mailing list]
 
* [http://groups.google.com/group/joomla-devel-docs Developer documentation mailing list]
 +
* [http://www.all-auto.ro/tractari-auto tractari auto]
 
* [[Project:MediaWiki setup notes|MediaWiki setup notes]]
 
* [[Project:MediaWiki setup notes|MediaWiki setup notes]]
 
* [http://forum.joomla.org/viewtopic.php?f=502&t=268156 Help screens white paper proposal] for Joomla! 1.6 onwards
 
* [http://forum.joomla.org/viewtopic.php?f=502&t=268156 Help screens white paper proposal] for Joomla! 1.6 onwards
 
* [[Documentors]] profile in this wiki.
 
* [[Documentors]] profile in this wiki.
 
[[Category:Documentation Working Group]]
 
[[Category:Documentation Working Group]]

Revision as of 08:01, 16 March 2010

The Documentation Team is Part of the Production Working Group. It 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.

Documentation wiki

<translate> The bulk of the documentation effort now revolves around this wiki. </translate> <translate>

  • Please refer to the Docs Wiki Roadmap for a complete overview of tasks.
  • If you are new to MediaWiki then you should consult the User's Guide for information on using the wiki software.
  • There are some conventions for making sure the Wiki remains organized.

</translate> <translate>

</translate> <translate>

  • You might want to take a look at

</translate> <translate>

</translate> <translate>

</translate> <translate>

  • Pages that define terms can be added to the Glossary, but not by adding [[Category:Glossary]] to the page. Please see Talk:Glossary for more information.

</translate> <translate>

Internal References

</translate> {{JDOC:Local wiki references/<translate> en</translate>}}


Other public resources