Examples and tutorials

Practical walkthroughs showing what the Platform AI Agent can do. Each example includes a prompt you can try and what to expect.

For a full breakdown of direct actions, approval actions, and guided handoffs, see Agent actions and approvals.

Find information fast

Prompt: "Search my docs for authentication setup"

The assistant searches your accessible documentation and returns relevant pages with links. Click any result to jump straight to that page.

Tip: Mention a specific Space name to narrow results, such as "Search my API docs space for rate limiting".

Read a full page

Prompt: "Show me the Getting Started page"

The assistant retrieves the complete content of the page and displays it in chat. This is useful when you want to review a page without navigating away from your current work.

Fix a mistake

Prompt: "Fix the typo in the second paragraph"

  1. The assistant identifies the issue and proposes a correction.
  2. You see a color-coded diff with removed and added content.
  3. Review the change and click Apply Changes to update the page, or Reject to discard it.

Tip: Be specific about where the issue is. It helps the assistant propose the right fix on the first try.

Add new content

Prompt: "Add a Troubleshooting section to this page"

  1. The assistant drafts the new section based on your page's existing content.
  2. The diff preview shows the addition.
  3. Click Apply Changes to add it to your page.

Create a new page

Prompt: "Create a Deployment Guide in my API docs space"

  1. The assistant generates the page content and shows a preview.
  2. Review the proposed content.
  3. Click Create Document to publish it to the Space.

Tip: Give the assistant context about what the page should cover, such as "Create a Deployment Guide covering Docker setup, environment variables, and CI/CD configuration".

Update multiple pages at once

Prompt: "Update pages that mention /v1/users to /v2/users"

  1. The assistant searches for pages containing the old reference.
  2. Each proposed change appears as a numbered item, such as "1 of 3".
  3. Use the navigation arrows to step through each change.
  4. Approve or reject individually, or use Approve All or Reject All.

Tip: Always review each diff, especially for bulk changes. The assistant may find matches in pages you did not expect.

Review pending Autopilot suggestions

Prompt: "Show pending Autopilot suggestions for this space"

The assistant lists pending suggestions so you can understand what changed and which pages may need updates.

You can then ask for a specific suggestion to be applied. The assistant prepares the request, and you confirm before anything changes.

Check a page against source code

Prompt: "Review this page against the linked repository"

If the Space is connected to a repository, the assistant can compare the page with linked source code and suggest updates.

If the Space is not connected to a repository, the assistant can still review the documentation itself, but it may ask you to connect the repository before it verifies code behavior.

Learn about DocuWriter.ai features

Prompt: "How do I connect my GitHub repo?"

The assistant searches the official DocuWriter.ai documentation and provides a clear answer with links to the relevant help pages.

If the next step requires an external account, such as GitHub, GitLab, Bitbucket, Azure DevOps, Confluence, or a billing portal, the assistant guides you to the right page and explains what to do there.

Get human help

Prompt: "I need help with my billing"

  1. The assistant drafts a support message summarizing your issue.
  2. You can edit the message in a text field before sending.
  3. Click Send to Support to submit, or Cancel to discard.

Nothing is sent without your explicit confirmation.

Tips and best practices

  • Be specific: mention Space names or page titles when possible. "Update the auth page in my API space" works better than "update my docs".
  • Review diffs before approving: especially for bulk changes, always check what is being modified.
  • Use separate threads: keep different topics in their own threads so the assistant has clear context.
  • Work from the right page: the assistant uses current page context when available, so navigate to the page you want to modify before asking for changes.
  • Connect repositories for source-aware help: linked repositories help the assistant check whether documentation matches your code.
  • Use dedicated generators for full builds: full repository docs, README generation, tests, diagrams, optimization, comments, and language conversion work best in the dedicated generators.