Mad Quality Plugin

Use the Mad Quality Plugin to validate your topics to ensure that they comply to your company style guide and information model. Say farewell to your style guide document and information model spreadsheet. The Mad Quality Plugin makes it easy for you to create consistent content your customers will love.

What can you do with the plugin?

  • Validate a topic against a Schematron rule file to validate style guide or information model compliance.
  • Validate writing quality, e.g. finding passive voice or lexical illusions.
  • Validate style guide compliance

The plugin comes with a set of pre-defined rules that you can change, and to set up your own rules, you create Schematron rule files in the \Flare.app\Plugins\Mad Quality Plugin folder.

For help setting up your own rules - contact me at mattias@improvementsoft.com.

Example animation

Writing.xml

  • Check readability.
  • Find duplicate words.
  • Find weasel words.
  • Find sentences that start with "So", or "There are/is".
  • Find paragraphs where an uncomparable is compared.
  • Find paragraphs with words that have simpler alternatives.
  • Find paragraphs with passive voice.
  • Find paragraphs with clichés.
  • Find headings with subordinate clauses.
  • Find headings with more than 7 words.
  • Find lists with inconsistent punctuation.
Example animation

US English.xml and UK English.xml

  • Find American English and UK spelling.
Example animation

Structure.xml

  • Finds topics with a missing <h1> element.
  • Find empty lists.
  • Find empty paragraphs.
  • Find topics with the <title> set.
  • Find divs without a class attribute.
  • Find elements with local styling.
  • Find hard-coded formatting (<b>,<i>,<u>)
  • Find lists with too many paragraphs.
  • Find lists with only one list item.
  • Find headings with index keywords.
  • Find consecutive lists that can be merged.
Example animation

Information model.xml

  • Make sure the topics has a heading 1
  • Make sure a task topic has at least one numbered list

The idea is that you copy this file and set up your own information model - creating assertions for each topic type (task, concept, reference).

Example animation

Let's discuss your project

Share all the details. The more we know, the better we can help you.

Contact form image for improvementsoft

Thank you! We'll be in touch within 24 hours.