Rice Knowledgebase: Guidelines
This document provides the guidelines for the migrating current how-to documents and quick reference documents from the Do-IT Yourself section of the wiki known as Docs (docs.rice.edu) to the KnowledgeBase (kb.rice.edu).
Terminology UsageWhen using KnowledgeBase [KB] terminology, always use capital letters “K” and “B”. Additionally, use KB abbreviation with capital letters “K” and “B” for short.
Create DocumentAuthors and Admins of documents for the Rice University OIT KB should adhere to the following guidelines. This includes new service documents; reviewing a current document; and/or migrating a document from docs, website, and other resources. Check KB for any duplicate documents/information.
Title of DocumentThe title of document should be consistent throughout the KB. For example: Office 365: FAQs and Office 365: How to Install Add an audience specific statement for clarification purposes. Currently Office 365 has limited support for Rice faculty, staff, and students.
Add keywordsIdentify the intended audience: All, Faculty, Staff, Student Use “All” if this document applies to everyone. Use the specific audience if the document is for a specific targeted audience. For example, Google Mail, the audience would be “student”.
TopicsThe current topics used in the Do It Yourself (DIY) section will be used for the KB. Additional topics can be added as needed. Submit request to KB Admin. Check KB for duplicate information.
PublisherIn the initial phase of this project, all documents will be subject to a review by KB Admin, service owner, and/or peer reviewer.
ReviewerReview document for technical accuracy. Use a non-technical person to test the usability as necessary. Add “comments” when sending draft to author for changes. Be sure the “periodic review date” is set for the author/owner to be notified. Note: May 31, xxxx / end of the semester. Use summer months for new, review, modifications, or archiving documents.