Skip to content

For the complete documentation index, see llms.txt.

How Promptless works

Promptless keeps your documentation current by connecting three pieces. Triggers signal when something changed, and context sources help Promptless understand the change. Doc collections define where your documentation lives and where updates are published. This page explains how those pieces fit together and how teams use them.

Keeping documentation current is hard work. Context gets lost in handoffs, updates fall behind releases, and support teams keep answering the same questions because the docs trail the product. Promptless drafts content in the voice of your existing docs and keeps screenshots in sync as your UI changes. It also shows the citations and reasoning behind every suggestion. Your team stays in charge of review and approval.

Teams use Promptless in different ways:

  • Vellum (YC W23) runs Slack Connect channels with key customers and uses Promptless to turn support conversations into documentation updates. Over 50% of Vellum’s docs PRs originate from Promptless. Each month, 60% of its product and engineering team uses Promptless to draft updates for features they own.
  • Amplitude’s technical writers couldn’t keep up with documentation demands, so the team uses Promptless to draft documentation for every feature release. Engineers review the first draft before it goes to customers.
  • Basis, an AI agents platform for accounting (ofbasis.com), uses Promptless for its entire knowledge base. Promptless processes the team’s meeting recordings and updates customer pages, internal guides for its fast-growing team, and customer-facing documentation.
  • Fortune 500 companies use Promptless to make their technical writers more productive. Their context is spread across Linear, Confluence, and Slack, and Promptless assembles the relevant information to draft doc updates for every PR.
  • Vitess, a CNCF graduated project, uses Promptless for its open-source docs. Since installing Promptless, 94% of its documentation updates have been drafted with Promptless.

Triggers, context sources, and doc collections connect to turn a change into a reviewed documentation update:

Diagram of how triggers, context sources, and doc collections connect in Promptless

1

Triggers start the process

Triggers are the starting point for every documentation update. They watch for events that might require documentation changes:

  • Code changes: GitHub pull requests, commits, and issues, and GitLab merge requests, start analysis when new features or fixes land

  • Team communication: Slack messages and Microsoft Teams mentions start documentation updates

  • Tickets and automation: Jira tickets, API calls, MCP requests from your editor, and recurring schedules start documentation work

Learn more in Triggers.

2

Context sources explain the change

Context sources are read-only integrations that give Promptless real-time access to the business context behind a change:

  • Project management: Linear issues and Jira tickets explain the requirements and rationale behind a feature

  • Knowledge bases: Confluence, Notion, Google Drive, and Slite carry specs, decisions, and existing product context

Context sources are optional. They help Promptless draft suggestions that explain why a change was made as well as what changed. Learn more in Context sources.

3

Doc collections receive the update

Doc collections define where your documentation lives and where Promptless publishes updates:

  • Docs as code: Your docs live in a Git repository and sync to a hosting provider such as Fern, Mintlify, or Docusaurus

  • Multiple collections: A single change can update more than one doc collection at once, so related docs stay in sync

Learn more in GitHub repos (docs as code).

These capabilities keep suggestions accurate and easy to review:

  • Voice Match: Learns the tone, sentence structure, formatting, and terminology of your existing docs, so suggestions read as if your team wrote them. See How Promptless learns your docs.
  • Promptless Capture: Keeps product screenshots in sync with your UI. When code changes affect a screenshot, Promptless detects which images need updating and regenerates them from your current interface.
  • Screenshot Editor: Crop, annotate, highlight UI elements, or add shapes and text to screenshots in the dashboard. Saved edits appear in your documentation suggestions right away.
  • Passive channel listening: Reads the Slack and Microsoft Teams channels you choose, such as Slack Connect customer channels. Promptless drafts a documentation suggestion when a conversation reveals something worth documenting. See Get the most out of passive channel listening.
  • CI checks before publishing: Reads the CI configuration in your docs repository. If it finds docs checks, such as Vale, it runs them on the files it changed. It fixes the failures, then opens the pull request or merge request.
  • Promptless Citations: Shows where each documentation change came from. Every update references the specific GitHub files, Slack threads, or support conversations that informed it.
  • Quickstart, to connect your repositories, docs, communication tools, and context sources.
  • Review and edit Promptless PRs, to see what happens when a suggestion lands and how to approve, edit, or dismiss it.
  • Open-source quickstart, to set Promptless up on a public repository through the free open-source program.
  • Triggers, to tune which events start documentation work for your team.

For setup guidance, contact help@gopromptless.ai.