Table of Contents
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 ✨
Creating great articles takes effort. Sometimes you know your content could be better but you're not sure exactly how to improve it.
That's where HelpDocs AI comes in to help you level up your documentation ✨
How to Use Improve with AI
- Head to your article
- Head to Readability panel (located at the bottom of your article editor sidebar) and click Improve
- Click Run analysis
- Wait for HelpDocs AI to work its magic and analyze your article (this usually takes seconds)
- Review your results and see suggestions highlighted inline
HelpDocs AI will scan through your entire article 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 directly in your article text when the Improve with AI panel is open. Click on any highlighted section to see the suggestion callout and apply changes right there.
You can also implement suggestions by clicking Apply in the main panel.
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.
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.
What did you think of this doc?
Understanding Ask AI