What Should go on the ITKB?
Are you thinking about moving documentation to the ITKB? Here are some guidelines to help you determine what belongs here and what doesn't:
- 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/does it pose a security threat if shared?
- 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).
- 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.
How to Transfer Documentation
Planning
Before you begin the process of transferring documentation, consider the following to help determine how best to move the content:
- Is this documentation related to an existing "section" of the ITKB? (See the left sidebar; e.g. Exchange, Account Administration, etc.). Should this documentation have its own section? Where in the ITKB does this content belong?
- Does the documentation require its own page, or can it be edited into an existing related page? Does it require multiple pages? How should it be organized?