Create documentation

Generate new documentation from your codebase, video uploads, or external sources.

Use create mode when you need documentation that doesn’t exist yet. The agent can generate content from your code, uploaded videos, or content pulled from integrations.

From your codebase

The agent analyzes your repository structure, source files, package configuration, and existing documentation to generate new content.

README files

Generate a comprehensive README when starting a new project or updating an outdated one.

Generate a README for this repository. Include:
- Project overview and key features
- Installation with npm and yarn
- Quick start example
- Configuration options
- Contributing guidelines

Tips:

Mention specific sections you need.
Reference example code: "Include examples similar to /examples"
Specify the audience: "Write for developers familiar with React"

API reference

Document endpoints, functions, or modules from your source code.

Document the authentication endpoints in src/api/auth.ts.
Include request parameters, response schema, example
requests, and error codes.

The agent extracts and documents:

Endpoint URLs and HTTP methods
Request parameters with types and descriptions
Response schema with field descriptions
Example request and response bodies
Error responses and status codes

How-to guides

Create task-oriented guides for common workflows.

Create a how-to guide for setting up local development.
Cover environment setup, database configuration, and
running the test suite.

Getting started guides

Help new users or contributors get up and running.

Write a getting started guide for new contributors.
Include repo setup, coding standards, and how to
submit a pull request.

From video uploads

Upload product demos, tutorials, or walkthroughs to generate documentation. The agent transcribes the video and creates structured content from what it sees and hears.

How it works

Click the attachment icon in the chat panel.
Select your video file.
Wait for processing. Transcription may take a few minutes.
Describe what documentation you need.

Example prompts

Create a step-by-step tutorial from this product demo.
Include descriptions of each screen and action shown.

Write a feature overview document based on this
walkthrough video. Focus on the key capabilities
demonstrated.

Generate release notes from this demo of new features.
Summarize each feature shown for end users.

From external sources

Pull content from connected integrations to create documentation. See Integrations to connect your tools.

From Slack threads

Turn support conversations and internal discussions into structured documentation.

Create a troubleshooting guide based on this Slack thread:
https://workspace.slack.com/archives/C01234/p1234567890

The agent extracts the conversation, identifies the problem and solution, and formats it as documentation.

From Notion pages

Transform product specs, design documents, or meeting notes into user-facing docs.

Create API documentation based on the spec in this Notion page:
https://notion.so/your-workspace/api-spec-page

From Confluence pages

Pull technical specifications or internal knowledge into your docs.

Create a deployment guide based on the runbook in this
Confluence page: https://your-org.atlassian.net/wiki/...

Release notes from tickets

Generate changelogs from completed Linear or Jira tickets.

Generate release notes for v2.1 based on Linear tickets
ENG-100 through ENG-110. Organize by Features,
Improvements, and Bug Fixes. Write for end users.

The agent reads each ticket’s title, description, and comments to create user-facing summaries.