Understand how the AI assistant turns a reader's question into an answer, so you can write docs that give the best possible answers.
📷 Image placeholder: a diagram showing question, search, matching doc sections and answer with sources.
From question to answer
The reader asks a question
The reader types a question in their own words, such as How do I make my docs private?
PinkDocs searches your docs
PinkDocs searches your published docs by meaning and keywords. This is the same search index used by live search.
PinkDocs picks the best sections
It selects the sections of your docs that best match the question. Sections are split by headings, so a long doc can contribute just the part that matters.
The AI writes the answer
PinkDocs sends the question and those sections to your AI provider. The AI writes an answer using only that content.
The reader sees the answer and sources
The answer appears in the chat with links to the docs it used.
When the assistant can't answer
If no doc section matches the question well enough, the assistant shows your fallback message instead of guessing. The question is saved in the AI report so you can write the missing doc.
Write docs the assistant answers well from
| Do this | Why it helps |
|---|---|
| Use clear headings that describe the task | The assistant picks sections by heading. |
| Cover one task per doc | Answers stay focused and accurate. |
| Use the words readers use | Questions match your docs more often. |
| Put steps in the Steps block | The assistant can repeat steps in the right order. |
| Keep docs up to date | Outdated docs produce outdated answers. |
| Spell out settings and menu paths | Answers can tell readers exactly where to click. |
Check how well it's working
Open the AI report
Go to PinkDocs → Analytics and open the AI report.
Check the answer rate
The answer rate shows the percentage of questions the assistant answered from your docs.
Read unanswered questions
Work through unanswered questions and write or update docs for them.
Common questions
As soon as you publish or update a doc, it's added to the search index and used for the next question.
Yes. Each answer links to its source docs.