Skip to content

Wiki Page Checklist

E-Hern Lee edited this page Apr 13, 2015 · 5 revisions

This page is aimed at assisting the writing of wiki pages for this wiki. It helps to clarify in the writer's mind what a wiki page should convey, and how it should convey it.

  • Each page should have a "directory structure" at the top of the page. Ex: Home > Conventions > Naming
  • Each page should have a clear title, summarizing what the page is about in less than 5 words
  • If the page has several headers, a table of contents should be provided
  • Each page should have a sentence or two explaining what that page is about, and what someone can expect to learn by reading that page
  • Each clear new section should have a clear, concise header
  • Each point should conveyed clearly, but concisely.
  • Links to anything outside assumed knowledge should be provided
  • Any images or videos that would assist in the illustration of a point could be included
  • If required a "further reading" section should be provided at the bottom of the document

Clone this wiki locally