Skip to main content
A documentation assistant should help readers find and apply published instructions. Start with a narrow product area and a reviewed source set, then evaluate whether answers are accurate, current, and traceable.
You can prepare sources, agent configuration, and test definitions now. A saved knowledge attachment does not establish working retrieval, and automated test execution and conversation runtime remain subject to current availability.

Prepare the source set

1

Choose a bounded scope

Select the product version, audience, and tasks the agent should cover. For example, answer setup and configuration questions for one public integration. Exclude internal plans, customer records, and outdated pages from a public assistant’s general knowledge.
2

Create and inspect knowledge documents

Use the knowledge-base workflow for reviewed URL, text, or file sources. Read stored content back and check processing status. Include stable source titles and canonical URLs so reviewers can trace instructions to their origin.
3

Attach sources to the intended agent

Create the agent first, then attach knowledge to the existing agent. The initial create-agent request rejects nonempty knowledge attachments. Review the selected branch and saved references before publishing a supported configuration.
4

Define answer boundaries

In the prompt, specify the supported product scope, how to ask for missing context, and when to say that the sources do not answer a question. Request source links only when the source is actually available. Do not let the agent invent package names, commands, settings, or release dates.

Build a review set

Store representative cases through testing. Review them manually while automated execution is unavailable. Once retrieval and runtime are released, compare answers with the exact source snapshot and agent version used for each run.

Maintain the assistant

Assign an owner to each source. When documentation changes, inspect the stored content and agent dependencies; do not assume a URL source automatically synchronizes. Recheck affected questions before treating an updated source as ready for public answers. Use model guidance to review the model selected for the task.

Frequently asked questions

No. This prepares the agent and source workflow. Website placement still requires a supported widget and session release.
Only after testing the released retrieval and answer path. A prompt requesting citations does not prove that a returned link supports the answer.