Checklist for Internal and Public-Facing Knowledge

This checklist is for Knowledge Editors to use when approving internal articles in TDX and when publishing public articles to the IT site.

Table of Contents

Process and Procedures

Style

Article Title

Internal Standards

  • Leads with the service or application name and version number(s) followed by a colon (when applicable)
  • Summarizes article contents

Additional Public Standards

  • Uses the active voice, e.g., create, assign, secure
  • Is 10 words or less
  • Uses title case
  • Uses words customers might search on
     

Content

Internal Standards

Additional Public Standards

  • Audience is clearly defined and is addressed as you
  • No jargon is used unless understood by intended audience
  • Content contains words customers might search on
  • Content is directed to the appropriate audience throughout the article
     

Format

Internal Standards

Additional Public Standards

  • Content is well ordered; topics and subtopics are in a logical sequence
    • Topic and subtopic titles: 
      • Are formatted as headings and are not bold
      • Use "ing" verbs when describing a process within the article content
         

Links

Internal Standards

Additional Public Standards

  • Links to other KB articles use the TDX URL, not the it.umn.edu URL.
  • Email addresses are spelled out
     

Images/Video

Internal Standards

  • Images are uploaded to server (not pasted in or attached)
  • Images include appropriate alt text (see Make Images Accessible)
  • Images are beneath the step(s) they illustrate
  • Images have a TDX-generated 1 pixel border (set in Insert/Modify Image window) to define edges when necessary (see Make Images Accessible)

Additional Public Standards

  • Images are essential to understanding the content and associated with the step they define
  • Images are cropped and sized appropriately
  • Videos have transcripts or closed captioning
     

TDX Article Settings

Internal Articles

  • Article is in the appropriate TDX Knowledge Category
  • Owner is set to a Group and selected based on agreement between stakeholders
  • Tags include any appropriate technologies or services.
  • Next Review Date is set
  • Notify Owner on Feedback is checked.
  • Article Summary is one sentence describing the article purpose

Public-Facing Articles

  • Category is Published Articles
  • Article Summary is the first sentence of the article
  • Tags include any appropriate technologies
  • Next Review Date is set
  • Appropriate Group is set as Owner, based on agreement between stakeholders
  • Notify Owner on Feedback is checked
  • Knowledge Internal Notes have been added when appropriate
TDX ID
5519