Documentation philosophy

Revision as of 07:19, 14 January 2006 by Helen (talk | contribs) (see also)

Jump to: navigation, search
  • Focus on MoodleDocs as the central Moodle knowledge-base
  • Transfer content from Using Moodle forum discussions (e.g. answers to how-to questions, ideas/suggestions of ways of using a particular feature) to MoodleDocs
  • Encourage newcomers to contribute to MoodleDocs
"New users are ideal for writing system-level documentation aimed at new users. They have the point of view and experience with the current software at the system level rather than at the library level. The most common evidence of this is FAQ lists, in which issues repeatedly raised on mailing lists and chat sessions are answered." Source: Documentation issues in open source
  • Encourage Using Moodle regulars to contribute to MoodleDocs by adding content in response to a question in the forums, then provide a link to the MoodleDocs page in the forum discussion e.g. Re: Backup problems forum discussion
  • Provide "See also" links in MoodleDocs to additional information in Using Moodle discussions e.g. Forums (though if the Using Moodle discussion leads to a conclusion/agreement then this should be transferred to MoodleDocs)

See also