How to write documentation with AI

Use GitBook Agent to work on your docs with an AI teammate that has the full context of your existing docs site

GitBook Agent is your AI teammate that helps you write, update, review, and maintain documentation — directly inside GitBook.

This video and guide will take you through GitBook Agent, covering:

• What GitBook Agent is, and common use cases
• Where to find GitBook Agent
• Drafting changes based on prompts
• Reviewing changes using GitBook Agent
• Working with GitBook Agent in comments
• How to manage change requests opened by GitBook Agent

What is GitBook Agent?

GitBook Agent is an AI assistant built into GitBook. It helps keep docs accurate and current.

It works mainly through change requests. That’s where your team already reviews and collaborates.

Basic workflow

1

Create a change request with the Agent

Click Edit on your docs. Then click Agent in the upper right corner to start chatting with GitBook Agent.

Describe what you want in plain language. Tag pages or sections if you want tighter context.

If you’re new to the branching workflow, start with change requests.

2

Let the Agent draft changes

The Agent reads relevant pages and proposes edits in the change request.

You can watch what it’s doing, and which pages it’s editing, as it goes.

3

Review what changed

Use the Changes tab (aka diff view) to review the full diff before anything goes live.

If you need tweaks, ask GitBook Agent for another pass inside the same change request.

4

Merge when you’re happy

When the updates look right, merge the change request to publish them.

Get help while you edit

Use the Agent panel

Open the GitBook Agent panel any time inside a change request.

Ask for focused work like rewriting a section, tightening tone, or fixing typos.

Use the Agent in comments

The Agent also works in comments. Mention it with @gitbook to request help on a specific block or paragraph.

Accept the suggestion if it’s correct. Ignore it if it isn’t.

Request an AI review

In any change request, open Request a review and select GitBook Agent. You can also request a review on work it didn’t create. The Agent can flag issues and check consistency.

Manage change requests at scale

Open the Change Requests dashboard from the left sidebar to triage work across your organization.

Filter by status (draft, in review, merged, archived). Inspect titles, reviewers, participants, and merge rules. Merge directly from the dashboard if you have permission.

Filter Agent-created change requests

Filter change requests by author to separate human edits from AI-assisted ones:

• Created by you
• Created by GitBook Agent

Related documentation

GitBook Agent

Request a review from GitBook Agent

Change requests