Just in case you don't get to the end of this post , a quick question. What's the position with the Wiki? Ready to accept contributions from all comers or still being set up?
I have few ideas that, although they will require a little
extra work now, should speed up the creation of documentation once things get
- Identify all of the elements in Moodle e.g. links, buttons, icons, drop down lists etc. (there arent too many variations) and produce a Wiki page with an official name for each (e.g. is that drop down list or drop down menu?). Specify the verb and nouns associated with each e.g. pick and item, select an option. The will help that create a common feel to the create documentation as contributors will be using the same terms. It should also make things easier for proof readers/editors too.
- Identify and agree the approach for each section e.g. does it start with an overview?, What is the logical way to work through item being documented?. We can probably come up with a general structure (more detailed than the one I spotted when looking at the Wiki a day or so ago) Edit: just had another look, some further work seems to have been done. There will be exceptions to the rule that can be trashed out as they arise. The benefit of this method is that there is a common approach across the docs and a framework is created into which it should be easier for the hordes of contributors to slot in their contributions.
- Impose which version of English is to be used less re-working later on and common feel throughout.
- Agree the tense (I think this is the correct term for what follows, its a long time since I studied English) of the docs e.g. Click the button to display the xyz page or When the button is clicked the xyz page will be displayed. My preference is for the former, wherever possible.
- Impose the theme which must be used for screen shots I know this has been discussed already, but things will be come a mess if contributors can use their own pet themes. Use of a variety of themes will be problematic for updating too IMO, especially the originator is not the one doing the updating.
- Create a Contributors site with restricted access to those contributing (already mooted but I think it would be useful to have dedicated site). This site would be available for the following purposes:
- Provide access to the Standard theme following on from my point above.
- Create a haven where contributors can construct the scenarios required to investigate, acquire screen shots and document features within Moodle. These can be quite involved and need to be safe from disruption.