Difference between revisions of "Documentation philosophy"

Jump to: navigation, search
(additional documentation)
(update)
 
(14 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==What documentation is required?==
+
{{Help}}* Focus on '''Moodle Docs''' as the central Moodle knowledge-base
* Documentation for every page in Moodle
+
* 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
* Additional documentation for
+
* Encourage newcomers to contribute to Moodle Docs
:Students
+
:"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]
:Teachers
+
* 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
:Administrators
+
* 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)
:Developers
 
  
==Documentation for every page in Moodle==
+
[[Category:MoodleDocs]]
* Moodle 1.6 will have a button in the header that links to pages in the wiki with the same path as the pages in Moodle e.g. https://docs.moodle.org/wiki/mod/forum/view/.
 
* Other languages will have the two-letter language code added e.g. "de".
 
* All help that refers to specific moodle pages/functions should be in this tree of pages.
 
  
==Additional documentation==
+
[[es:MoodleDocs:Filosofía de la documentación]]
* Any other pages created should have short, single-word, lowercase URL names. The reason is to try and keep things generic enough to avoid breaking links later. If the titles are long with many words then we'll have to rename them sooner, which breaks links.
+
[[fr:Philosophie de la documentation]]
 
+
[[zh:文档的哲学]]
[[Category:MoodleDocs information]]
 

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)