Creating and editing teaching content

From techdocs
Jump to navigation Jump to search
  1. Look here and here for editing help.
  2. Use descriptive page titles so they can be found by searches. For example, not "creating repos", but "COMP1531 creating repos at start of session".
  3. For pages which are specific to one or more courses prefix the page title with the applicable course numbers separated by slashes. This avoids confusion with similar pages created for different courses. For example, a page named "Marking Prac Exam" is going to be hopelessly inappropriate for most readers. Instead call it something like, "COMP1541/BINF4321 - Marking Prac Exam".
  4. For pages which are not specific to any course use a helpful and descriptive title as mentioned above, e.g., "General instructions regarding configuring assignment submission".
  5. This wiki supports the creation of page categories which makes displaying related pages very easy. To add a page to one or more categories, add category links to the bottom of each page. E.g., to add a page to the COMP1541 and BINF4321 categories, add "[[Category:COMP1541]] [[Category::BINF4321]]" to the bottom of the page (use uppercase for the course ID). You might also like to include the page in other categories such as "[[Category:exams]]" or "[[Category:assignments]]".
  6. Make sure any pages you create are appropriately linked to something. If no other pages link to it your page becomes an orphan. Although people may find it through search, it's going to be more useful if it's linked to pages to which it is relevant.