AI Agent

AI Agent helps editors create and improve documentation pages by drafting content, restructuring sections, and suggesting targeted edits you can review and apply.

Unlike AI Writer (which provides inline assistance and a limited set of functions), AI Agent can reference your documentation content to inform its suggestions.

Who can use AI Agent

AI Agent is available to all editors (excluding reviewers).

Where to find AI Agent

You can open AI Agent from the page editor:

• Open any documentation page
• In the right sidebar, select AI Agent

What AI Agent can do

AI Agent can help you:

• Draft new pages (for example, a first pass from an outline or requirements)
• Revise existing text (clarity, tone, consistency, and completeness)
• Generate summaries (section or page-level summaries)
• Plan and outline (propose structure before writing)
• Restructure content (reorder sections, break up long blocks, improve scannability)

Scope and constraints

• AI Agent suggestions are scoped to a single page.
• AI Agent can propose edits to page content, but it cannot modify frontmatter.
• AI Agent can handle documentation blocks automatically (for example, callouts, tabs, tables), and will include them in its suggested changes when appropriate.

How AI Agent works

AI Agent can use your documentation content to improve relevance and consistency:

• It can access the current version you’re editing.
• It can reference all pages and content in that version, including drafts and unpublished content.
• It can reference the current page.

When it proposes a change, AI Agent provides one or more edit suggestions. You choose whether to apply them.

Applying edit suggestions

AI Agent never applies edits automatically.

• You can apply suggestions selectively (apply one without applying others).
• When you apply a suggestion, the change is applied to the page in draft mode.
• Applying a suggestion does not automatically save the draft—make sure to save your work.

If the page changed

If the page content has changed since the suggestion was generated, you’ll be informed that the edit can’t be applied. In that case, ask AI Agent to perform the same change again based on the updated page content.

When to use AI Agent vs AI Writer

Use AI Writer when you want inline help while you write (with a limited set of functions, and no tool-connected documentation lookup).

Use AI Agent when you want broader assistance on a page - planning, restructuring, summarizing, drafting - and suggestions informed by the documentation in your current version.

Tips for better results

• Tell AI Agent your goal and constraints (audience, tone, length, and required sections).
• Point it to the relevant section to revise (for example: “Rewrite the ‘Authentication’ section for clarity, keep headings.”).
• Ask for options when you’re unsure (for example: “Give me two alternative outlines.”).