What is GitBook Agent?

Work with an AI teammate to keep your documentation accurate, complete, and up to date

GitBook Agent is an AI teammate that works alongside you. It helps you keep your documentation accurate, complete, and current. GitBook Agent is deeply integrated into GitBook. You don’t need new workflows to use it.

If you edit your docs locally with an AI assistant, use GitBook’s skill.md file.

What can GitBook Agent do?

GitBook Agent can:

• Write docs based on a prompt: Ask GitBook Agent to update a page, rename a product, or make any other change you need.

• Import content into GitBook: Attach files like PDFs and Microsoft Word documents in the GitBook Agent chat sidebar. GitBook Agent extracts and formats the content into pages in your space.

• Plan and implement bigger changes: Describe what you need. GitBook Agent opens a change request, explains its edits, responds to feedback, and implements the plan you create together.

• Understand your style guide: Add your style guide in your site settings, and GitBook Agent applies it when writing or reviewing content.

• Follow custom, site-level instructions: Give GitBook Agent site-specific instructions, such as how to add links or which block types to avoid.

• Translate your documentation: Choose the content you want to translate, select a language, and GitBook Agent localizes your docs.

• Summon from a comment: Add a comment to any block on your page, type @gitbook, and tell GitBook Agent what you need.

• Review change requests: Add GitBook Agent as a reviewer on your change request. It can act as a docs linter, flag style guide issues, and suggest or fix errors.

Automatic documentation suggestions

Automatic docs suggestions are in early access

Head to Agent audit to learn more.

GitBook Agent can also connect to the signals your team uses to understand your product and your customers’ needs: support conversations, tickets, and threads from your connected tools.

With this context, GitBook Agent can identify gaps, propose updates, and generate docs changes automatically.

As your docs evolve with your product, your customers get the right information when they need it.

Explore GitBook Agent’s features

Write with GitBook Agent

Create content from a prompt, or edit a single block

Review with GitBook Agent

Ask GitBook Agent to check your work for spelling, grammar, and style

Translate your docs site

GitBook Agent can create auto-updating localizations

Add a style guide and custom instructions

You can configure GitBook Agent with your team’s style guide or site-specific instructions.

GitBook Agent uses this context whenever it creates or edits content for that site.

To add a style guide or custom instructions, open your site’s Settings and choose the Agents tab. Add your instructions in the custom instructions field.

You can also open this screen from a change request. Open the GitBook Agent chat window, then open the Actions menu and choose Configure GitBook Agent .

Custom instructions example

Here’s an example of the custom instructions you can 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.

FAQs

How does GitBook Agent use my data?

We follow our data protection practices to keep your data private.

GitBook Agent does not use your data to train AI models. We share the information you add to GitBook Agent with OpenAI only to provide GitBook Agent. See OpenAI’s privacy policy for more information.

How much does GitBook Agent cost?

GitBook Agent is free for all plans while in beta. If you’re not on Pro and not on a trial, free usage includes 10 messages per week.

Translations are priced separately as a monthly add-on. Visit the pricing section to find out more.

Can I override the default tone of GitBook Agent’s output?

Yes. You can override GitBook Agent’s default personality and tone.

If you want more detailed output, or a specific style or tone, tell GitBook Agent in site-level instructions or in a prompt in a change request.