Skip to main content

Build with AI

Lewis Smith-Tong
Lewis Smith-Tong
  • Updated

Create complete pages of documentation

Build with AI helps you create comprehensive documentation pages by leveraging your existing styleguide content and AI-powered generation. Build with AI creates complete page structures including tabs, blocks, and formatted content. If you only want to create text content, use Write with AI.

Like all AI-powered features in zeroheight, a team admin needs to enable AI features via team settings before Build with AI is available for other users.

How to use Build with AI

Getting Started

Build with AI is available when creating new page:

or when adding content to page via the Build option in the inserter menu:

Build with AI will only create new tabs on a page when used on a blank page via the option to "Build a page with AI".

Providing instructions

When you choose to Build with AI, you’ll need to  provide:

Page name

Only editable when using the "Build a page with AI" option on an empty page

Page objective

The purpose of the content you want to be created, what the content is for. Use the page objective in combination Tone of voice settings (If you want to control the tone of voice of the output you should use the Tone of voice settings since these settings apply to all AI generated content in zeroheight) and Reference pages.

The more detailed information you provide, the closer the output will be to what you want. Examples include:

  • the tabs you'd like to be created
  • the zeroheight blocks you'd like to be included in the output
  • specific, detailed information about what's being documented (e.g. variants and properties of the component you are documenting)

Reference pages

You can optionally select up to 3 existing pages from your styleguide that will influence the tabs, content blocks and tone of the content being generated.

Content generation

When Build with AI is invoked via "Build a page with AI" on an empty page, the output may include page tabs.

Alongside text (including headers, bullet lists etc.), Build with AI can also generate the following zeroheight blocks:

  • Rules
    • pre-populated with some suggested rules
    • but will also need to be populated with designs/images
  • Callouts
    • pre-populated with suggested content
  • Design, Storybook, Shortcut tiles, Images, Tokens, Live code
    • in an empty/placeholder state
  • Horizontal dividers

The specific content that is generated will depend on the page objective and reference pages.

The tone of voice of the text content will be influenced by:

  • the tone of voice instructions (if present)
  • the tone of voice of the selected reference pages (if no tone of voice instructions are provided)
  • the tone of voice of related pages (if no reference pages are selected, related pages are other pages in the same section of the styleguide )
  • an instruction to generate content that is "professional yet casual, written in plain language, and concise" (if there is no content on related pages)

Once you click Generate, content will be streamed into the page and focus will automatically shift to new tabs (if they're created) — you know content is still being generated by the Generating content modal that shows on the bottom left of the editor.

If you attempt to change tab while the content is being generated you'll see the following warning:

Review the content

Once the content has completed generation, you'll see an option to Accept, Reject or Retry at the bottom of the page (or each tab, if tabs were created):

Accept places the generated content on the page

Reject removes all of the generated content from the page

Retry re-opens the Build with AI modal where you can tweak your instructions and try again.

If you navigate to another page without selecting an option, the content is automatically accepted. Once accepted, generated content can be edited just like any zeroheight content.

You should carefully review the written content generated by build with AI, since it's possible that content is reflect common/best practice rather than then specific details of your design system,

You should also review the empty/placeholder blocks and populate them with the necessary content.

FAQ

How is Build with AI different from Write with AI?

Write with AI focuses on generating text content, while Build with AI creates complete page structures with multiple block types and tabs.

Can I opt out?

Yes! If, at any point after opting in, you no longer want to use Build with AI in zeroheight, you can disable all AI features from your team settings. Deactivating the AI features will remove the Build with AI option from the block inserter but won’t remove any content that has been previously generated.

Will you use our data for training purposes?

Neither zeroheight nor OpenAI will use any customer data for model training purposes.

What data is shared with OpenAI?

When you use Build with AI the following is shared with OpenAI

  • the page name
  • the page objective
  • the content of reference pages
  • the content of related pages

Can I use Build with AI on pages that already contain content?

Yes. When using Build with AI on pages that already contain, new tabs will not be created.

Are there usage limits to Build with AI?

Each usage of Build with AI consumes 1 "prompt" from your team's monthly AI usage limit. Limits vary by plan for more information see plan limits.

Can I regenerate content if I don’t like the results?

Yes, you can click Retry after the content has been generated to edit your prompt and try again.

Is OpenAI a subprocessor of my data?

We have added OpenAI to our list of sub-processors. The Build with AI feature will not process personal information unless you input personal details into the prompt. As a reminder, customers should not input personal information into AI features or the content they upload to the platform more generally (see terms and conditions).

For full details on the terms that apply to the use of AI features, please see our AI Terms.

How can I provide feedback on this feature?

If you have feedback on this feature, or any other zeroheight feature, please let us know by contacting support@zeroheight.com or in our Slack community, Zheroes.

Share this article
Was this article helpful?