Documentation philosophy: Difference between revisions

Latest revision as of 03:58, 31 August 2006

Focus on Moodle Docs 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 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 Using Moodle 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 Using Moodle discussions e.g. Forums (though if the Using Moodle discussion leads to a conclusion/agreement then this should be transferred to MoodleDocs)

@@ Line 1: / Line 1: @@
-==What documentation is required?==
+{{Help}}
-* Documentation for every page in Moodle
-* Additional documentation for
-:Students
-:Teachers
-:Administrators
-:Developers
-==Documentation for every page in Moodle==
+* Focus on '''Moodle Docs''' as the central Moodle knowledge-base
-* 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/.
+* Transfer content from [http://moodle.org/course/view.php?id=5 Using Moodle] forum discussions (e.g. answers to how-to questions, ideas/suggestions of ways of using a particular feature) to Moodle Docs
-* Other languages will have the two-letter language code added e.g. "de".
+* Encourage newcomers to contribute to Moodle Docs
-* All help that refers to specific moodle pages/functions should be in this tree of pages.
+:"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 Using Moodle 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 Using Moodle discussions e.g. [[Forums]] (though if the Using Moodle discussion leads to a conclusion/agreement then this should be transferred to MoodleDocs)
-==Additional documentation==
+==See also==
-* 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.
+*[[MoodleDocs development]]
 [[Category:MoodleDocs]]
+[[es:MoodleDocs:Filosofía de la documentación]]
+[[zh:文档的哲学]]