What is GitBook Agent?
Work with an AI teammate to keep your documentation accurate, complete, and up to date
Last updated
Was this helpful?
🇺🇸 English
Work with an AI teammate to keep your documentation accurate, complete, and up to date
Last updated
Was this helpful?
Was this helpful?
GitBook Agent is an AI teammate that works alongside you, helping you keep your documentation accurate, complete, and current.
The Agent is deeply integrated into GitBook, so you don’t need to learn new workflows to take advantage of it — it works alongside you using the processes you already know.
GitBook Agent can:
Write docs based on a prompt: Ask the Agent to update a page with the latest information, replace every mention of a product name with a new name, or anything else you need.
Ideate and implement bigger changes: Describe what you need and the Agent will open a change request, explain its planned edits, respond to your feedback, and then implement the plan you’ve created together.
Understand your style guide: Add your style guide into your org’s settings and it will always apply it when writing or reviewing content.
Follow custom, organization-level instructions: Give the Agent specific instructions at an organization level, such as adding links in specific ways, or avoiding specific block types.
Translate your documentation: Choose the content you want to translate, select a language and the Agent will do the work of localizing your docs.
Summon from a comment: Add a comment to any block on your page, type @gitbook and tell the Agent what you need.
Review change requests: Add the Agent as a reviewer on your change request. It can act as a docs linter, identifying or fixing errors, suggesting improvements and flagging style guide deviations.
The Agent can also connect to the same signals your team uses to understand your product and what your users need: support conversations, tickets, and threads from your connected tools.
With this context, the Agent can proactively identify gaps, propose updates and generate docs changes automatically. So your docs can evolve with your product, and your users always get the right information when and where they need it.
You can configure GitBook Agent by adding your team’s style guide or specific instructions on how you’d like it to work with your team. The Agent will use these as context whenever it creates or edits content in your organization.
To add a style guide or custom instructions, open your Organization settings and then choose the GitBook Agent section. Click the Settings tab and add your instructions in the text entry field.
You can quickly access this screen by opening the GitBook Agent chat window in a change request, then opening the Actions menu and choosing Configure GitBook Agent .
Here’s an example of the kind of custom instructions you could add in GitBook Agent’s settings.
You are a technical writer at Stripe. Use clear, direct language and prioritize accuracy over flourish. For guides, always introduce the concept with a one-sentence summary and break content into well-structured sections. For quickstarts, always use a stepper and keep every step action-first and concise.Write with GitBook Agent
Create content based on a prompt or edit a single block
Review with GitBook Agent
Ask the Agent to check your work for spelling, grammar and style
Translate your docs site
GitBook Agent can create auto-updating localizations
