Difference between revisions of "Documentors"
From Joomla! Documentation
m (Added category) |
(Corrected some URLs. Other formatting changes. Removed the Needs Updating tag.) |
||
| (19 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Documentor profile}} | + | <noinclude><languages /></noinclude> |
| − | ==General== | + | {{Chunk:Documentor profile/<translate><!--T:1--> |
| − | Please be aware that the official language of the project is British | + | 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 | + | * Please read the [https://developer.joomla.org/en-gb-user-interface-text-guidelines/introduction.html Joomla! en-GB User Interface Text Guidelines]. |
| − | * [ | + | * [https://github.com/joomla/user-interface-text/blob/master/words2watch.md Words to Watch (W2W)] |
| + | </translate> | ||
| − | ==Documentation | + | <translate> |
| − | {{:Documentation wiki}} | + | == Documentation Wiki == <!--T:4--> |
| − | ==Help | + | </translate>{{:Documentation wiki/<translate><!--T:5--> |
| − | The [[Documentation Working Group]] is responsible for writing and maintaining the official | + | en</translate>}} |
| − | * [[Help screens| | + | <translate>== Help Screens == <!--T:6--> |
| − | * [[Setting up a local help server]] | + | </translate> |
| − | + | <translate><!--T:7--> | |
| − | + | The [[S:MyLanguage/Documentation Working Group|Documentation Working Group]] is responsible for writing and maintaining the official Help screens. For Joomla! versions from Joomla! 1.6 onwards, the Help screens will be hosted on this site. | |
| − | + | </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> | ||
| + | <noinclude> | ||
| + | <translate> | ||
| + | <!--T:11--> | ||
[[Category:Joomla! user profiles]] | [[Category:Joomla! user profiles]] | ||
| + | </translate> | ||
| + | </noinclude> | ||
Latest revision as of 18:34, 10 July 2022
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[edit]
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.
- Please read the Joomla! en-GB User Interface Text Guidelines.
- Words to Watch (W2W)
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 you should consult the MediaWiki Handbook for information on using the Wiki software.
- There are some conventions for making sure the Wiki remains organized.
- Use the Image naming guidelines.
- Observe the convention for labeling 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
- Articles that require a review (also awaiting a copy editor)
- Articles for which information is required: you may be the one that knows certain details
- 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.
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 link search.
- 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 and Wikipedia.
Help Screens[edit]
The Documentation Working Group is responsible for writing and maintaining the official Help screens. For Joomla! versions from Joomla! 1.6 onwards, the Help screens will be hosted on this site.