Actions

Difference between revisions of "Documentors"

From Joomla! Documentation

m (removing category)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Chunk:Documentor profile}}
+
<noinclude><languages /></noinclude>
==General==
+
<noinclude>{{page|needs updating|}}</noinclude>
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.
+
{{Chunk:Documentor profile/<translate><!--T:1-->
 +
en</translate>}}
  
 +
<translate>
 +
==General== <!--T:2-->
 +
Please be aware that the official language of the project is British English (en-GB).  There is a tendency for American spellings to creep into the documentation; feel free to correct these wherever you see them.
 +
</translate>
 +
 +
<translate>
 +
<!--T:3-->
 
The following material is important for documentators working on all areas of the Joomla! project.
 
The following material is important for documentators working on all areas of the Joomla! project.
 
* Please read the '''[http://help.joomla.org/files/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.
 
* Please read the '''[http://help.joomla.org/files/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.
* [[Project:Words to watch|Words to watch]]
+
* [[S:MyLanguage/Project:Words to watch|Words to watch]]
 +
</translate>
 +
 
 +
<translate>
 +
==Documentation wiki== <!--T:4-->
 +
</translate>
 +
{{:Documentation wiki/<translate><!--T:5-->
 +
en</translate>}}
  
==Documentation wiki==
+
<translate>
{{:Documentation wiki}}
+
==Help screens== <!--T:6-->
==Help screens==
+
</translate>
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.
+
<translate>
* [[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]
+
<!--T:7-->
* [[Setting up a local help server]]
+
The [[S:MyLanguage/Documentation Working Group|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.
* [http://joomlacode.org/gf/project/joomla/docman/?subdir=6 Help screens SQL dump files] for Joomla! versions up to 1.5.x.
+
</translate>
 +
<translate><!--T:8-->
 +
* See [[S:MyLanguage/Category:Help screens|Category: Help Screens]].</translate>
 +
<translate><!--T:9-->
 +
* [[S:MyLanguage/Setting up a local help server|Setting up a local help server]]</translate>
  
[[Category:Working Groups]]
+
<noinclude>
 +
<translate>
 +
<!--T:11-->
 
[[Category:Joomla! user profiles]]
 
[[Category:Joomla! user profiles]]
 +
</translate>
 +
</noinclude>

Latest revision as of 09:05, 17 April 2015

Other languages:
English • ‎français • ‎Nederlands • ‎русский
Copyedit.png
This Article Needs Your Help

This article is tagged because it NEEDS UPDATING. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


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 English (en-GB). 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.

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.



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.