Actions

Difference between revisions of "Documentors"

From Joomla! Documentation

m
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Documentor profile}}
+
{{Chunk:Documentor profile}}
 +
==General==
 +
Please be aware that the official language of the project is British/Australian English.  There is a tendency for American spellings to creep into the documentation; feel free to correct these wherever you see them.
  
* If you are new to MediaWiki then you should consult the '''[http://meta.wikimedia.org/wiki/Help:Contents User's Guide]''' for information on using the wiki software.
+
The following material is important for documentators working on all areas of the Joomla! project.
* List of '''[[local wiki templates]]''' that can be used in your wiki pages.  Templates reduce repetition and are the basis of modular documentation.
+
* Please read the '''[http://help.joomla.org/files/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.
* 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.
+
* [[Project:Words to watch|Words to watch]]
* 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 [http://php.net/manual PHP documentation] or [[wikipedia:Main_Page|Wikipedia]].
+
 
* Please read the '''[http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.
+
==Documentation wiki==
* [[Help:Words to watch|Words to watch]]
+
{{:Documentation wiki}}
* requested but yet [[Special:Wantedpages|empty pages]]
+
==Help screens==
* [[:Category:Articles under review|Articles under review]] awaiting a copy editor
+
The [[Documentation Working Group]] is responsible for writing and maintaining the official help screens.  For Joomla! versions up to and including 1.5.x the help screens must be hosted on a Joomla! instance.  From Joomla! 1.6 onwards the help screens will be hosted on this wiki.
* [[:Category:Landing Pages|Landing pages in this wiki]]
+
* [[Help screens|Joomla! 1.5.x help screens]] are created on this wiki before being moved to [http://help.joomla.org/content/section/42/278/ help.joomla.org]
* Pages that define terms can be added to the [[:Category:Glossary|Glossary]] category by adding <nowiki>[[Category:Glossary]]</nowiki> at the end of the page.
+
* [[Setting up a local help server]]
* [[Project:MediaWiki setup notes|MediaWiki setup notes]]
+
* [http://joomlacode.org/gf/project/joomla/docman/?subdir=6 Help screens SQL dump files] for Joomla! versions up to 1.5.x.
* [[Cookie jar]]
+
 
 +
[[Category:Joomla! user profiles]]

Latest revision as of 14:16, 30 November 2013

As a documentor you have the unenviable task of creating material for a wide range of readers from beginning users to advanced professional developers. You will need to know how to use various tools (such as this wiki) and you will need to read guidelines and other meta documents. You will probably need to update those documents over time too.

General

Please be aware that the official language of the project is British/Australian English. There is a tendency for American spellings to creep into the documentation; feel free to correct these wherever you see them.

The following material is important for documentators working on all areas of the Joomla! project.

Documentation wiki

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

  • 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.
  • 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.

Help screens

The Documentation Working Group is responsible for writing and maintaining the official help screens. For Joomla! versions up to and including 1.5.x the help screens must be hosted on a Joomla! instance. From Joomla! 1.6 onwards the help screens will be hosted on this wiki.