Difference between revisions of "Documentation philosophy"

Jump to: navigation, search
(documentation requirements)
(additional documentation)
Line 8: Line 8:
  
 
==Documentation for every page in Moodle==
 
==Documentation for every page in Moodle==
* Every page in Moodle could have a help button in standard locations (in the header and footer).
+
* 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/.
* The link this button contains would be automatically generated based on the page URL you are currently on: eg: https://docs.moodle.org/index.php/course/view - this "master" page will be in English.
+
* 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.
  
==Further ideas==
+
==Additional documentation==
* Each documentation page will have its versions in other languages. If a page in a language other than English does not have any content, it will either be pre-filled with the English content, or will contain a link to the English version.
+
* 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.
* When a new version of Moodle comes out, all of the contents of the documentation will be copied to a new location, e.g. https://docs.moodle.org/1.6/, where we'll modify it to match the features of the new release.
 
  
 
[[Category:MoodleDocs information]]
 
[[Category:MoodleDocs information]]

Revision as of 18:14, 21 November 2005

What documentation is required?

  • Documentation for every page in Moodle
  • Additional documentation for
Students
Teachers
Administrators
Developers

Documentation for every page in Moodle

  • 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

  • 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.