House Style

What House Style does

House Style adds a House Style tab to MadCap Flare Desktop. It lints your topics against a style guide and lists the issues it finds. You change or ignore each one.

Every change is a Flare tracked change. Accept it, reject it, or undo it with Ctrl+Z, like an edit from a colleague.

Three kinds of checks

CheckWhat it findsCost
Style rulesWords to avoid, spellings, product names and other rules from the style guide's tables. Each comes with an exact fix.Free
StructureImages without alt text, skipped heading levels, tables without a header row, vague link text, and phone numbers, email addresses and URLs typed instead of a variable.Free
AI reviewWhat a table can't express, such as passive voice, wordiness or unclear steps. Each issue names the rule it applies.A few cents per topic

Style rules and structure checks run on your computer. The AI review is optional. You can use House Style with no AI at all.

Where the rules come from

The rules come from these sources. A later source wins over an earlier one.

  1. Google: the Google developer documentation style guide, built in.
  2. Our rules: your team's style guide, or your own changes if you don't have a team guide.
  3. This project: the open project's variables, glossary and its own rules.

To see every rule, select House Style > Rules. See Browse and change style rules.