Knowledge Base: Overarching Principles

Summary

The overarching principals behind why the Knowledge Base is the way it is (theoretically) and the way we wish it would be.

Clear and concise writing that is easy to understand
- More information in Basic Style Guide
Everything that can be publicly visible should be. See: Permissions and Visibility
Don't recreate Google
- If information is an easy Google search away, think carefully about whether we need to also maintain that information in our own KB
Don't recreate vendor support sites
- Link out to vendor support whenever possible rather than duplicating their content into our KB (and then having to maintain the duplicate content)
We DO want to provide curated, local, current information about how technological things work at Carleton with Carleton Systems for Carleton People.
- Outdated information clutters result lists, so we'll delete or archive information that isn't current
Build articles as needed, and then refine articles as we go
1. Find It!
  Always search the KB when working on a ticket
2. Flag It!
  If you find a relevant KB article, say whether it was useful and up-to-date or not
3. Fix It!
  If you know how to improve the article, edit it and submit your draft for review
4. Add It!
  Didn't find an article you needed? Start one and submit it for review, even if it's just a stub
Attach KB articles to Tickets whenever possible
Pay attention to and respond to feedback on articles so that we constantly refine our content

Article ID: 145099

Created

Fri 7/15/22 5:35 PM

Modified

Mon 7/18/22 12:03 PM