Documentation checker
A documentation checker reads every page of your docs and tells you where they are wrong, stale or inconsistent, so you do not find out from a customer. Paste your docs address and get a graded report with the exact pages and quotes.
What it checks
- Pages that give different answers to the same question
- Near-duplicate pages and pasted-in repeated sections
- Pages that describe old versions or carry old dates
- Broken internal and external links
- Thin pages and pages nothing links to
How it works
- Paste the address of your docs, help center or knowledge base.
- We read up to 300 public pages (more when you sign in, free), obeying robots.txt.
- You get a graded report with every problem, the exact pages and quotes, and a one-click task list.
Questions
What is a documentation checker?
A tool that scans documentation and reports quality problems that readers and AI assistants run into: contradictions, duplicates, outdated pages, broken links and orphan pages.
How is this different from a spell checker or linter?
Spell checkers and linters look at one file at a time. A documentation checker compares pages with each other, which is where contradictions and duplicates show up.
Does it work on any docs platform?
Yes, on any docs site or help center that serves its text as HTML, including Docusaurus, GitBook, MkDocs, ReadTheDocs, Zendesk, Intercom, Help Scout and WordPress.