Procedure: KM / Review and publish a KB draft

Objective

  • To provide instruction on reviewing and publishing draft content to the Knowledge Base

User

  • Knowledge Base Manager
  • Publisher
  • Super-SME (Subject-matter Expert)

Environment

  • 348532: Knowledge Base (KB)
  • 56345: Knowledge Management (KM 2.0)

Procedure 

  1. In the KB editor, review the draft against content and format standards  
  2. Make a clear distinction between Objective and Scope, if a scope of the procedure is included 
    • Objective: the purpose of the article
    • Scope: the limits to which the procedure or guide is applied
  3. Under Environment, include the asset number and name for every application or system mentioned or listed in the article 
  4. Go to the TDX CMDB and add the article title to each asset record listed
  5. Check each link to be sure that it will open in a new window and projects an advisory title when scrolled over
    • Apply the correct Target and Advisory Title to each link given in content: 
      • TargetNew Window (_blank)
      • Advanced > Advisory TitleLink opens in a new window
  6. Under the Settings tab in the Subject field, check for an appropriate title in the following format:
    • Example: Procedure: <Service, Application, or Asset Name> / <Resolution>
    • Example: Fulfillment: <Service, Application, or Asset Name> / <Resolution>
    • Example: Support Guide: <Service, Application, or Asset Name>
  7. Select the correct Category
    • Be aware that viewing permissions start at the Category level 
  8. Add the correct tag for the type of internal procedure: SOP, Analytical, or Maintenance
  9. Change Status to Approved and check the Published to KB box
  10. Change Next Review Date to the first of the month, twelve months from date of publication
  11. Change Owner to the owning group of the primary asset; check Notify Owner on Feedback
  12. Check the name of the Responsible SME or Group
  13. Check the name of the Responsible Project Group, if any
  14. Check the name(s) of the Supported Office or Community
  15. Select Save
  16. Under the Permissions tab, ensure that viewing permissions are correct for the article and category 
  17. Under the Related Articles tab, add each article that is mentioned in the content 
  18. Under the Related Services tab, add each service or service offering that is mentioned in the content