Difference between revisions of "Documentation philosophy"

Jump to: navigation, search
 
(update)
 
(20 intermediate revisions by 9 users not shown)
Line 1: Line 1:
The following are the ideas for the structure of Moodle Documentation:
+
{{Help}}* Focus on '''Moodle Docs''' as the central Moodle knowledge-base
 +
* Transfer content from moodle.org forum discussions (e.g. answers to how-to questions, ideas/suggestions of ways of using a particular feature) to Moodle Docs
 +
* Encourage newcomers to contribute to Moodle Docs
 +
:"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: [http://www.oss-watch.ac.uk/resources/documentation.xml Documentation issues in open source]
 +
* Encourage moodle.org regulars to contribute to Moodle Docs by adding content in response to a question in the forums, then provide a link to the Moodle Docs page in the forum discussion
 +
* Provide "See also" links in Moodle Docs to additional information in moodle.org forum discussions e.g. [[Forums]] (though if the forum discussion leads to a conclusion/agreement then this should be transferred to MoodleDocs)
  
* Every page in Moodle could have a help button in standard locations (in the header and footer).
+
[[Category:MoodleDocs]]
  
* The link this button contains would be automatically generated based on the page URL you are currently on: eg: https://docs.moodle.org/course/view
+
[[es:MoodleDocs:Filosofía de la documentación]]
 +
[[fr:Philosophie de la documentation]]
 +
[[zh:文档的哲学]]

Latest revision as of 10:33, 18 June 2018


  • Focus on Moodle Docs as the central Moodle knowledge-base
  • Transfer content from moodle.org forum discussions (e.g. answers to how-to questions, ideas/suggestions of ways of using a particular feature) to Moodle Docs
  • Encourage newcomers to contribute to Moodle Docs
"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 moodle.org regulars to contribute to Moodle Docs by adding content in response to a question in the forums, then provide a link to the Moodle Docs page in the forum discussion
  • Provide "See also" links in Moodle Docs to additional information in moodle.org forum discussions e.g. Forums (though if the forum discussion leads to a conclusion/agreement then this should be transferred to MoodleDocs)