You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Some tips for writing wiki pages:

  • Write for the web. See Google: write for the web
  • Write short pages focused on a single topic.
  • Since your pages will be short, don't use table of contents on your pages.  If you feel the need for a table of contents, break up your content into multiple pages
  • Label your pages.  See All Labels for a list of labels currently in use.  But don't worry about navigation or labels. Your page may be renamed, relabeled or otherwise made easier to find by others.
  • Rely on wiki formatting. No need for HTML or complexity. Let the wiki format your work.
  • Rely on wiki navigation.  If you would like to suggest a page order within some page hierarchy, please contact @mconlon or one of the other wiki maintainers.  Do not use "Child Pages" on your page.  The left hand navigation provides all the visual clues people need to browse the wiki.
  • Work logged in to the wiki. Write and update your pages as you work. This results in highly topical, accurate pages.
  • There are many well-written guides for wiki authors. Find a popular one-pager, and give writing a try.
  • No labels