Proofread

Proofread checks a topic for grammar, spelling, and unclear sentences in one click, and shows you the corrections to review before anything is saved. For a translated topic, it also compares the translation against the original and, if you use the Translation Glossary, makes sure your required terms are kept.

Category: Authoring · Status: Beta · Plan: Enterprise · Requires: AI Editor and AI Assistant, which are installed with it

Before you start

Proofread uses the AI Assistant's settings, so the AI Assistant must be switched on in Organization Settings > AI Assistant. Proofread works on rich text topics.

Proofread a topic

Open the topic and open the AI Editor or AI Assistant panel.
Select Proofread at the top of the panel.
If corrections are found, review them in the proposal, then select Apply to topic or Discard.

Applying saves the corrections as a draft. It doesn't publish the topic.

The Proofread button is hidden while another proposal is waiting for you to apply or discard it.

What you might see

No corrections needed. The topic is fine as it is.
The AI's version changed required glossary terms, so your text was kept. Proofread never replaces your text with a version that drops a term from your glossary. The message lists the affected terms.
The AI's version changed the formatting, so your text was kept. Proofread only corrects wording. If the result would change your headings, lists, tables, or other formatting, your text is kept instead.
Proofreading could not run right now. Try again in a moment.

Translated topics

When you proofread a topic in a language other than the document's main language, Proofread also checks it against the main-language version, so meaning lost in translation is caught too. If the Translation Glossary addon is installed, your glossary terms are enforced as well.

If you uninstall it

The Proofread button disappears. Corrections you already applied stay in your topics. Proofread is also uninstalled when you uninstall the AI Editor or the AI Assistant.