Compendium AI Document Generation

AI

Overview

When creating a document in the Compendium, you can choose to generate the document content using AI. Monty generates documentation tailored to a specific documentation type — such as API reference, architecture overview, or user guide — based on context from your project.

This is one of three document creation methods in the Compendium. The other two are creating manually (blank editor) and creating from a story. See the Creating Documents guide for the full overview.

Getting there

1Open the Compendium from the sidebar
2Select a section in the left tree where you want the new document
3Click + New Document or the add icon next to the section
4In the creation dialog, select Generate with AI as the creation method

Documentation types

When generating with AI you select a Documentation Type that shapes the structure and tone of the generated content. Available types are defined by the getDocumentationTypeList() configuration and typically include:

  • API Reference — endpoint descriptions, request/response schemas, examples
  • Architecture Overview — system components, data flows, integration points
  • User Guide — step-by-step instructions for end users
  • Technical Specification — detailed implementation requirements
  • Release Notes — changes, fixes, and new features for a release
  • Runbook / Operational Guide — operational procedures and troubleshooting steps

The exact list of available types may vary based on your organisation's configuration.

Generating a document

1Select Generate with AI in the document creation dialog
2Enter a Document Title
3Select the Documentation Type that best matches the content you need
4Optionally add context or instructions to guide Monty's output
5Click Generate — Monty produces the document content
6The document opens in the Lexical editor pre-filled with the generated content in DRAFT status
7Review, edit as needed, and save the document

After generation

The generated document is created as a DRAFT. You can edit it in the Lexical rich-text editor before submitting it for review or publishing. See the Document Approval Workflow guide for how to move the document through review and publication.

Troubleshooting

The Generate with AI option is not available

Check that your role has permission to create documents in this section. Product Owners and Project Managers have full create permissions. Also confirm that AI features are enabled for your organisation.

The generated content is not relevant to my project

The Documentation Type selection strongly affects the output. Try a different type that better matches your intended content. You can also add explicit context in the instructions field before generating.

The generated document is blank

This may be a temporary issue with the AI service. Try generating again. If the problem persists, create the document manually and use the Compendium editor to write the content.

On this page