Skip to main content

Best Practice: Create a Checklist for High Quality Content (MT4)

This article provides criteria for assessing the quality of your MindTouch knowledge. You should use this criteria as a basic framework to start measuring and understanding your knowledge quality. Over time, your criteria should evolve while adapting to the requirements of your industry and business.  

It is important to note that a high-quality article is expected to meet roughly 80% of the criteria that you put in place. To learn more about measuring the quality of your MindTouch knowledge, please refer to our best practice on managing your MindTouch article quality with AQI.

Why should I create quality criteria?

Essentially, you want to create quality criteria to ensure that your knowledge is consistently thorough, accessible and facilitating learning.  The criteria example that we have created below aims to ensure your knowledge is thorough, optimized for Google, and encourages learning.  

Creating quality criteria and regularly measuring the quality of your knowledge can also provide you with important metrics to highlight the evolution of your knowledge and authors over time.  

Basic criteria example

At MindTouch, high quality knowledge will meet 8/10 of these requirements.  As you develop and evolve your criteria, it is likely that a similar percentage will also ensure quality.  Defining quality criteria that is too rigid can complicate your knowledge.  For instance, it may not make sense to have a code example if you also have a video.  



Example / Notes

A title that appeals to a human with a job

Creating Beautiful How-To’s for Your Developers
unchecked_checkbox_icon.png Author bar Who wrote the article? Learn how to create an author bar.
unchecked_checkbox_icon.png Version indicator What version of your product does this article apply to? Learn how to create a version indicator.

Overview header

2-3 sentences. Will show in search results. 

An Objective or Goal

Why should you care? Why should I use this?

An instruction list

  • Step 1:    Got to Tools > Control Panel

  • Step 2:    Click Site CSS

unchecked_checkbox_icon.png What it looks like header A photo of what it looks like when the customer properly follows the directions in that document

2+  hyperlinks


2+ images, screenshots, or diagrams


3+ tags


A code or HTML example 

<a href="http://help">This is how you add a hyperlink</a>

Minimum of 200 words 

Word count is provided in the MindTouch editor under the header controls (Normal, H1, H2, H3...)
unchecked_checkbox_icon.png An Article-Type Topic, How-To or Reference
unchecked_checkbox_icon.png Search Recommendations Add search recommendations for every article by going to Site Tools > Control Panel > Search ("Search" is found on the left of the Control Panel at the bottom of the list)