Automation for Docs
In Docs, agents help you write, check and update documents. Helpin's documentation agent is Quill. You can bring an agent into a single document, or run scheduled checks across a whole space.
Mention an agent in a document
Type @ followed by the agent's name in a document, the same way you mention a teammate. When the document is saved with the new mention, the agent starts a run on that document and looks for the next useful action.
Only agents allowed to work on documents respond to mentions. See Give agents tools and skills and Agents overview.
Run an agent on a document
From Automation → Agents, select an agent, select Run now, choose Document as the target and paste the document's ID in Target ID. Add Run instructions to say what you want, for example "check this page against the latest release". The Document target is listed only for agents allowed to work on documents.
Review changes an agent proposes
When an agent proposes an update, you review it before it changes the document.
Open the document. A pending proposal shows Quill proposed an update.
Review the Proposed changes and any sources the agent cites.
Select Apply to accept the change, or Discard to reject it.
If a block changed after the proposal was created, discard the proposal and ask the agent to propose again from the latest version.
Schedule documentation checks
In Automation → Flows, select Browse templates. Templates for Docs include:
Template | What it does |
|---|---|
Internal docs freshness sweep | Checks internal docs on a schedule and saves a freshness report. |
Public help freshness sweep | Checks public help docs and saves a customer-facing freshness report. |
API docs freshness sweep | Verifies API docs against source code and saves an accuracy report. |
Release Notes Writer | Drafts release notes from a GitHub release and prepares a Docs proposal. |
When you install a template, you choose the schedule, which space or collection to review, and where to save the report. Some templates can use a repository so Quill can check claims against your product's code. See Creating a flow.
Tools agents use in Docs
Docs tools let agents search and read documents, write content, manage spaces and collections, and propose changes for review. See Built-in tools overview.
See what happened
Every run appears in Automation → Activity. See Agent runs and runtimes.
Was this article helpful?