KnowledgeBase (KB) - Departmental Support Training
Live Demo from August 6, 2024
FAQ
What is a KB Group Space?
A "KB Group Space" is where your team's documentation lives in the KB.
In our case, the "DoIT Departmental Support" KB space will generally be used by GDS, TS, and FS for their documentation. SEAM will have the "DoIT SEAM" KB space for their documentation.
How will the KB spaces be organized (DS, GDS, TS, FS, SEAM, HDL2, etc)?
GDS, TS, and FS will use the DoIT Departmental Support KB space. SEAM will use the new SEAM KB space.
The current "DoIT HDL2 KCS" space will become the Contract Partner KB space, which will contain HDL2 documentation.
SEAM will be able to read and write documentation in the DS KB space. DS will be able to read documentation in the SEAM space.
What is In Progress, In Review, Active, and Inactive?
Documents can be in four different states:
- In Progress: A document in this status is actively being edited. It may be a new document that has never been published or a previously published document that requires edits.
- In Review: A document in this status indicates edits are complete and are ready to be reviewed and/or published. Use this status to have new documents activated, to have updated documents activated, or after adding notes to indicate action is necessary.
- Active: A document in this status has been properly reviewed and revised. Once a document is Active, it is published and available on the live, KB site. If you have publishing rights, you can skip the review step and publish on your own.
- Inactive: A document in this status has become obsolete or expired.
How do I publish a document?
If you have "publish rights" in the KB, you should be able to publish the document on your own (bypassing the In Review -> Approval -> Published process).
If you don't immediately see that option, you may need to save your progress on the document (either by setting it to "In Progress" or clicking "Save Changes"), and then you will be able to Activate the doc if all of the required fields (Title, Keywords, Summary, Body) are completed.
Will the KB creator be notified if someone else updates the KB article?
In your group space, you can send a notification/additional comments to the owner of the KB document before making any edits.
Should we follow a standard font size?
Yes. The font size cannot be changed.
The KB has a standardized font size that can only be changed by manually editing the HTML.
How do I add an image to an ordered list without affecting the formatting?
Use Shift + Enter to create a new line underneath your current line in the ordered list. This will not impact the formatting or numbering in the list.
Then, add your image in the new line.