Knowledge Base Article Guidelines

Enter a title for the article that will be obvious to users searching for the article

• Capitalize standard Titles:
  • "Ethos Applications & Tools"
  • "Procurement Terms and Definitions"
• Titles formatted as a question should have only the first word and proper nouns capitalized and a question mark at the end:
  • "How to share Zoom recordings from OneDrive?"
  • "What software is available for students?"

• Use the format dropdown menu to select Heading sizes (2,3, or 4) to insert in the article. for each section. DO NOT use Heading 1 because the title is that size
  • For overview and section titles, use Heading 2
  • For sub-sections, use Heading 3
• All articles should have an Overview Section which includes a bulleted list of sections if there are more than two sections
• After creating a heading:
  • highlight the entire heading title
  • click the Anchor button (flag) 
  • add an Anchor Name
    • Note that Anchor names cannot contain spaces. Keep it as one word or use a "-" to separate words. 
      • For example, instead of "Classroom Help Calls" you will do "Classroom-Help-Calls" when creating the anchor.
  • Click OK
• Be sure to link the section titles in the bulleted list to the corresponding Anchors:
  • Highlight the section title in the bulleted list
  • Click the Link button (chain)
  • Change the Link Type to "Link to anchor in the text"
  • Select the correct Anchor
  • Click OK
  • Also, use the Text Color tool to change the color of the highlighted text to blue. Though it already looks blue in editing mode, that goes away in the published version.

Add images where relevant to support the user. Use the following method:

• leave one space after the text where you want to insert the image
• click on the Image tool
• click on the Upload tab
• click Choose file and find the image
• click Send it to the server
• click OK when the verification window pops up
• enter 1 in the Border field
• click OK

Use Greenshot to edit photos for adding step-by-step instructions to articles to support users

• You can access Greenshot from the Show hidden icons up arrow in the lower right of the desktop 
• To take a screenshot, choose Capture region or use the prnt scrn button on the keyboard, then click and drag to select the image you need. 
• Then select Open in image editor 
• Use the Rectangle tool to highlight items in the image, the Speech bubble tool to add instructions, and the Add counter tool to number the steps 
  • To be sure the image is accessible:
    • use red to outline items with the Rectangle tool
    • use black text on a white blackground for speech bubbles
    • use a white number on a red background for the Add counter tool
• Save your image
• To add the image you've created to the KB article, use the Image tool that appears in the toolbar when you're editing the article in TDX.
  1. Select the Upload tab and then
  2. Click Choose file to upload the image.
  3. Click Send it to the server 
  4. Click OK when the success message pops up 
  5. Be sure to complete the Alternative text field to describe the image in detail
  6. Add 1 in the Border field
  7. Click OK