Creating help pages

Here are some general guidelines for creating help pages for the website:

  • Where possible, use numbered or bulleted lists to break up the steps in a procedure
  • Try to use descriptive labels for the different menus and options available to the users.  Specifically, not the menu title and page location (left-hand column, right-hand column, page header).  For example: users can access help by click in the "Help" link in the Navigate menu on the top of the left-hand column of every page.
  • When time permits, uploading screen shots is very helpful.  A simple tool to generate screen shots is SnagIt, which has a free 30-day trial: http://www.techsmith.com/download/snagittrial.asp
  • When making external links, please use click the "Target" tab in the link editor and choose "New Window (_blank)" so the link will appear in a new window or tab.