USE CASE

A documentation AI assistant for more docs than anyone reads

An AI support agent that answers from your documentation, links the page it used, and shows you which questions and which pages leave readers stuck.

Published

A product with hundreds of pages of documentation still gets asked questions those pages answer. Someone wants to stop an old API key working, and the answer sits under a heading that calls it credential rotation, three levels down a sidebar they never opened.

Deacon stands between that reader and your docs. They ask in their own words and get the answer, and the page it came from is linked under it. You get a list of the questions your pages could not answer.

Why docs search misses

Documentation is self-service support, and a docs search box is the usual way in. It matches the words somebody types against the words on your pages, so it only serves the reader who already knows what the thing is called. Type “how do I stop my old key working” and none of your pages say that.

Deacon reads a question for what it means, so that reader lands on credential rotation. A keyword index runs alongside, so an error code or a flag name still finds the one page that contains it. The documentation guide explains how the two work together.

Every answer is a way into the docs

Each answer that came from a page on your site carries a link to that page, so the reader is one click from the full explanation.

Deacon answering whether two years of invoices can be exported, with a link under the answer to the documentation page it came from.

Deacon can only link pages it read from your site, so add your documentation as a website. An uploaded file has no address, and answers drawn from it arrive without a link.

Getting a large site in

Give Deacon your documentation’s address and it walks the site and lists what it finds. Nothing is in the AI knowledge base yet. Every page arrives switched off, laid out in the folders your URLs make, and ticking a folder ticks every page inside it.

On a big documentation site that list deserves ten minutes. Changelogs, notes for releases nobody runs any more and generated reference pages are all text Deacon will treat as true. Leave out anything you would not want quoted back at a customer, and press Retrain agent when the list looks right.

Your plan sets how many pages a month Deacon fetches and how much text it holds, and the pricing page gives both. The free plan needs no card and holds enough to try this on part of your documentation. A page you missed can be added on its own by its address, and it is learned straight away.

Readers who write in another language

Deacon replies in the language of the reader’s latest message, whatever language your pages are written in.

A developer in São Paulo can ask in Portuguese, get the answer in Portuguese from your English pages, and follow the link to the English original.

When readers who write in other languages go unanswered more often than readers who write in English, Analytics › Widget raises it as a finding and names the languages. It only does so once there are enough questions on both sides to compare.

The page they were on

Deacon records the page each question was asked from. When one page stands out for questions it could not answer, compared with the rest of your site, the Where in your product panel appears on Analytics › Widget and names it. The panel also shows your busiest pages for questions, and how often Deacon answered on each.

Docs on one subdomain, the app on another

Plenty of products keep the documentation at docs.example.com and the app at app.example.com. Deacon treats those as two sites. List both on the Install page, which the install guide walks through, and the same tag works on each, with every question landing in one dashboard. A bare domain and its www version count as one, and nothing else is matched for you.

Questions no page answers yet

Each question Deacon could not answer is listed under Unanswered in Conversations, with a box beside it for the answer. A written answer joins the knowledge base as soon as it is saved. Analytics › Widget groups the unanswered questions that mean the same thing, so you can see which gap the most people hit.

For a documentation team that list says what to write next. Most items are a paragraph missing from a page you already have, or a page that does not exist yet. A few are problems with the product itself.

Try it on your own documentation

Add your help pages, ask it the question you know your docs cannot answer, and watch it say so.

The free plan covers 50 answers a month on one seat, and the paid plans are on the pricing page.

Start free

Free plan, no card.

READ NEXT