Skip to main content
Support

Understanding Improve with AI

Improve with AI analyzes your articles for clarity and engagement, delivering specific recommendations and readability scores to level up your docs ✨

River Sloane
Updated by River Sloane
4 min read

Table of Contents

Improve with AI gives you the power of a personal senior editor. It keeps in mind the context of all your other articles and your AI style guide.

Your administrator may need to enable this in your account AI settings first.
This feature is available on certain plans.

How to Use Improve with AI

  1. Head to your article
  2. Click Improve in the bar at the bottom right of the editor
    Editor toolbar with word count, an Improve button, and tooltip reading Run AI analysis.
  3. Click Run analysis. Each analysis uses 5 AI credits.
  4. Wait for HelpDocs AI to work its magic and analyze your article (this usually takes seconds)
  5. Review your results and see suggestions highlighted inline

    Screenshot of the Improve with AI review panel displaying an article quality score and suggestions.

HelpDocs AI will scan through your entire article, and any open comments your team has left on it, looking for ways to make it clearer, more engaging, and easier to understand.

You'll get a total score out of 100, plus specific suggestions for improvement. Generally, scores above 80 indicate well-optimized content, while scores below 60 suggest room for significant improvement.

Once the analysis is complete, you'll see improvement suggestions highlighted in your article text. These only appear when the Improve with AI panel is open.

Click any highlighted section to see the suggestion callout. You can apply changes right there.

You can also implement suggestions by clicking Apply in the main panel, or apply every remaining suggestion at once with Apply all. Click the X on a suggestion to dismiss it.

Each suggestion you apply uses 1 AI credit. Apply all shows the total number of credits on the button before you click it. A suggestion costs one credit even if the AI decides nothing needs changing. Articles skipped before the AI starts, because they have moved on, aren't charged.

If you edit the article after an analysis, you'll see a warning that some suggestions may no longer fit, with a Review again button. Reviews also expire after a while: once one has, click Re-run to apply suggestions again.

Focus on the highest-impact recommendations first, and don't feel obligated to implement every suggestion. Use your judgment to decide what fits best for your content and audience.

What Improve with AI Looks For

Every suggestion falls into one of six categories. You'll see them as groups in the panel, each with a count of how many suggestions it holds.

Category

What it checks

Example suggestion

Readability

Sentence length, reading level, clarity, jargon, and passive voice

Split the long opening sentence into two

Completeness

Missing information, unclear steps, and gaps a reader would run into

Explain where to find the download link

Tone

An inconsistent voice, the wrong register, or anything that drifts from your AI style guide

Match the friendly tone used in the rest of the article

Links

Topics that should link to another article, and existing links that look wrong

Link to the article about AI credits

SEO

The title, description, headings, and keyword coverage, so readers can find the article in search

Use the term readers search for in the first heading

Structure

Heading hierarchy, formatting, lists, callouts, and how the article flows

Turn the setup steps into a numbered list

Before suggesting a link, HelpDocs AI searches your Knowledge Base to check the article it wants to link to actually exists.

How Suggestions Are Labeled

Each suggestion also has a severity, so you can tell at a glance which ones matter most:

Severity

What it means

High

A significant problem your readers will run into

Medium

A noticeable issue worth fixing

Low

Polish, for when the bigger things are done

Under the Apply button, each suggestion tells you how it can be applied:

Label

What it means

1 credit

HelpDocs AI can make the change for you, such as rewording a sentence, adding a link, or fixing a heading

Manual

The change needs your judgment, such as confirming a fact, deciding what to cut, or editing the title, description, or tags

An analysis returns up to 12 suggestions. If your article is already in great shape, you'll get a high score and fewer suggestions, or none at all.

Sharing Suggestions with Your Team

Want to collaborate on improvements? You can download a PDF that details all the improvement suggestions. This makes it easy to share analysis results with your team for review and discussion.

If you've already applied some suggestions, these will be clearly marked in the PDF so your team knows what's been implemented.
Click Show example next to any suggestion to see exactly what HelpDocs AI is thinking of applying. This makes it crystal clear what will be changed.

What did you think of this doc?

Previous Configuring HelpDocs AI Next Understanding Ask AI