MoodleDocs:Guidelines for contributors

You are welcome to contribute to Moodle documentation :-)

Before you start, please read the following:

1. Before you contribute to a page, read the Note for Contributors (if it exists) near the top of the page.
2. Many of the documentation pages explain what can be seen on a particular page in Moodle. For example, the documentation page "Viewing and grading submissions" explains what can be seen on the page in Moodle where the teacher can view and grade assignment submissions. The url of that page is something like moodlesite.com/mod/assignment/submissions.php. Therefore, when contributing to the documentation, always pay attention to the heading of the documentation page. If it contains a part of a url (e.g. mod/assignment/submissions, it means that this documentation page refers to this page in a moodle site: moodlesite.com/mod/assignment/submissions.php. The reasons for this are explained here.
3. Whenever possible, make use of the help files which are built into Moodle (accessible via the yellow question mark icon) as the starting point for writing the documentation.
4. If you choose to contribute to this documentation, please note that all text and media (e.g. screenshots) you provide will be released here under GNU Free Documentation License 1.2.
5. Preferably, all documentation text and media should be based on the 1.5 release of Moodle. However, if you only have access to an older version of Moodle, don't worry, just contribute whatever you can. We'll just add all the 1.5-specific stuff later :-) (Oh, BTW, if you'd like to play with Moodle 1.5, you can do it on the Moodle Demo Site)
6. The standard theme is preferred for making screenshots. However, if you do not have access to it, you may base your screenshots on another theme.
7. Follow the naming standards
8. Although it is possible to edit the documentation as an anonymous user, please, do create a user account and remember to log in before you start making changes.
9. For the time being, let's concentrate on creating the documentation for teachers. We'll move on to the other sections later.
10. If you need to discuss any issues relating to a particular page, use its "discussion" page (available through a tab at the top of the page).
11. If you are planning to write the content of a certain page, you may "reserve" it for yourself. Just write a notice at the top of this page, saying
    • that you would like to reserve it
    • by when you're planning to write the text
    • your name
12. Firefox has a nice extension which adds a toolbar to help you with your wiki work: [1]

For help on using the wiki, click "Help" in the navigation menu on the left.