Help article checker
Paste a help article and get a readability score with specific fixes: reading level, long sentences, passive voice, steps, headings, and whether the answer comes first.
Link this tool
Embed or cite the help article checker
Copy a Markdown or HTML badge for your docs, blog, or README. Free, no signup.
How to write help articles people can follow
Lead with the answer
Most readers want one thing. Put the answer or the result in the first one or two sentences, then the steps, then the exceptions.
One action per step
Number the steps and give each one action, with the exact name of the button or setting. Readers switch between the article and the product, and numbers help them find their place.
Write for a tired reader
Short sentences, plain words, and active voice: "You can export invoices", not "Invoices can be exported". Aim for grade 9 or lower; it helps everyone, including customers reading in a second language.
FAQ
What is a good readability score for a help article?
Grade 9 or lower, with most sentences under 20 words. Technical terms customers need are fine; explain them the first time.
Is my article sent anywhere?
No. The checks run in your browser and nothing you paste leaves the page.
How long should a help article be?
As long as the task needs. Most task articles run 150 to 600 words; if one covers several tasks, split it so each title matches one search.
Readable is half of it; the other half is correct. usedocs drafts articles from real customer questions and proposes edits when your code changes what an article says.
Start a 7 day free trial