Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Is the documentation directed toward technicians or clients?
    • The ITKB is intended to be written for a technician audience. Documentation that answers questions for end users (e.g. set-up instructions, FAQs, etc.) is still perfectly appropriate because it's also useful for technicians, but clients should not be purposely directed to the ITKB as a source of information.
  • Does the documentation need to be private?
    • Currently, the ITKB is viewable by the world. This means that anything that absolutely must be kept private (e.g. admin passwords) is not currently appropriate for this wiki. Openness and information sharing is a large part of the ITKB's value, but if necessary and appropriate, it's possible to restrict pages/sections to Tufts technicians only (talk to Molly).
  • Is this information already on the ITKB?
    • We'd like to avoid duplicate pages, so please take a look and do a search before adding new content to the ITKB. If the information or similar information exists, consider whether it will make sense to remove an outdated page, update an outdated page, or edit the page to merge different bits of related information onto one page.
  • Will this documentation be useful or interesting to other people?
    • It doesn't matter! If you're not sure if anyone will ever read or use the documentation, share it anyway (provided it meets the requirements above). You never know when your process will help another group refine theirs, or your information about a new project will lead to collaboration with another group, etc.

...