Documentors
From Joomla! Documentation
(Difference between revisions)
m |
m (removing category) |
||
| (9 intermediate revisions by 6 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. | ||
| − | * | + | 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]'''. |
| − | + | * [[Project:Words to watch|Words to watch]] | |
| − | * | + | |
| − | * | + | ==Documentation wiki== |
| − | + | {{:Documentation wiki}} | |
| − | + | ==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. | |
| − | + | * [[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] | |
| − | + | * [[Setting up a local help server]] | |
| − | + | * [http://joomlacode.org/gf/project/joomla/docman/?subdir=6 Help screens SQL dump files] for Joomla! versions up to 1.5.x. | |
| + | |||
| + | [[Category:Working Groups]] | ||
| + | [[Category:Joomla! user profiles]] | ||
Latest revision as of 22:16, 29 August 2012
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.
[edit] 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.
- Please read the Joomla! Editorial Style Guide.
- Words to watch
[edit] 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.
- There are some conventions for making sure the Wiki remains organized.
- Try to use the Image naming convention.
- Try to observe the convention for labelling pages with Joomla! version numbers.
- You might want to take a look at
- the requested but yet empty pages
- the Cookie jar: a list of pages that have been categorised as being small, well-defined tasks that require minimal commitment to complete
- Category:Articles that require a review (also awaiting a copy editor)
- Category:Articles for which information is required: you may be the one that knows certain details
- Category:Articles that could be improved: these are not quite as good as they could be
- Landing pages: pages that match important keywords used by people using search engines to find documentation.
- 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.
[edit] 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.
- Joomla! 1.5.x help screens are created on this wiki before being moved to help.joomla.org
- Setting up a local help server
- Help screens SQL dump files for Joomla! versions up to 1.5.x.
