KB Article Review Checklist

Overview

Use this checklist each time you review your Knowledge Base article. Work through each section in order, making corrections as you go. If you are unsure how to fix something, refer to the KB Content Standards and Guidelines (UWEC login required) or contact the KB Team.

Content

• Is the content still accurate and up to date?
  • Verify all information reflects current processes, tools, and policies.
• Is the content still relevant?
  • Consider whether the article is still needed.
• Have all steps been tested?
  • Test any step-by-step instructions to confirm they still work as described.
• Are technical terms and acronyms explained?
  • Acronyms should be spelled out on first use.

Visual Presentation

View your article as a reader before checking the items below.

• Are there any stray headings sitting alone on their own line?
  • Lingering heading tags should be removed. You can find these when viewing an article—a link icon will appear with no text to follow.
• Is spacing consistent throughout?
  • Look for unexpected gaps or crowded sections.
• Are images sized appropriately?
  • Most images should be 500px wide or smaller unless detail requires otherwise.
• Do any images have stale captions?
  • Remove or update any auto-generated captions like "image.png 86.4 KB".
• Is body text formatted as paragraph text, not as a heading?
  • Body text should never be formatted using a heading style.

Heading Structure

• Does the article use proper heading hierarchy?
  • Headings should not skip levels (e.g., do not jump from Heading 2 to Heading 4).
• Have you reviewed the Contents list?
  • The auto-generated table of contents is a quick way to spot heading structure problems. If the outline looks wrong, the headings need fixing.
• Are headings free of bold or italic formatting?
  • Headings should not have additional bold or italic applied on top of the heading style.

Links

• Do all links work?
  • Click every link in the article to confirm it is not broken.
• Does every link have descriptive anchor text?
  • Avoid generic labels like "click here" or "read more." Good examples: "Contact the Help Desk," "Submit the KB Access Request Form."

Lists

• Are all lists created using the editor's list tool?
  • Lists should not be typed manually with dashes, asterisks, or other characters.
• Are numbered and bulleted lists used correctly?
  • Use numbered lists for steps that must be completed in order, and bulleted lists for non-sequential items.

Images and Alt Text

• Do all images have alt text?
  • Every image must have descriptive alt text.
• Is the alt text meaningful and descriptive?
  • Alt text should describe what the image means in context. Do not begin with "Image of" or "Picture of." "Screenshot of" is acceptable.
• Does the article text stand on its own without the images?
  • Users who cannot load images must be able to follow the article using text alone.

Formatting and Style

• Button text is bold. Example: Click Save
• Field names and interface areas are italicized. Example: Scroll to the Images section
• Dropdown and selectable options are bold italic. Example: Select Control Panel
• Keyboard commands use [brackets]. Example: Press [Ctrl + S]
• Bold and italics are used sparingly. Avoid applying them to whole sentences or paragraphs

Metadata

• Is the article title still accurate?
  • Format: [Action/Topic] + [Subject] + [Context if needed], 5-10 words, title case.
• Is the category assignment still correct?
  • Confirm the article is in the right category.
• Is the article type correct?
  • Confirm the article type—How-to Guide, Reference, FAQ, or Troubleshooting—is accurately assigned.