Skip to content

For the complete documentation index, see llms.txt.

Run a pilot

Promptless offers 14-day pilots for growth and enterprise customers. A pilot shows how Promptless works with your own documentation, team workflows, and trigger events, so you can:

  • See Promptless handle different types of documentation updates
  • Evaluate suggestion quality across different scenarios
  • See how well Promptless fits into your team’s workflow

This guide covers preparing for the pilot, the onboarding workshop, the success criteria to agree on, and the weekly check-ins that follow.

  • A Promptless account. See the Quickstart.
  • Optional. Your docs may need foundational work before a pilot, such as documenting major missing features, completing a large refactor, or creating documentation from scratch. Tell the Promptless team. Subject to availability, the team may be able to help with these projects before your pilot begins.

Before the pilot begins, connect Promptless to your workspaces and share your documentation standards with the Promptless team. Promptless uses them to draft an initial batch of suggestions. For connection instructions, see the Quickstart.

  1. Connect your source code repositories on GitHub, GitHub Enterprise, or GitLab.

  2. Connect your documentation repository on GitHub or GitLab, for example the repository behind a Mintlify, Fern, ReadMe, or Docusaurus site.

  3. Connect Slack or Microsoft Teams, so you get notified about new suggestions and can tag Promptless in threads or messages to request doc updates.

  4. Recommended. Connect Jira or Linear to give Promptless context about the customer-facing impact of new features.

  5. Share the material you’d give a new technical writer: your style guide, your Vale configuration if you use one, and documentation standards or templates.

We recommend starting every pilot with an in-person workshop.

Duration

A 90-minute session. For larger teams, we may run several workshops over a few days.

Preparation

Before your session, we run Promptless on historical events, such as the last 30 days of PRs. You then review real suggestions during the workshop.

What we cover

How Promptless works, your configuration, and hands-on review of suggestions, with the goal of publishing your first doc updates together.

By the end of the workshop, you and the Promptless team:

  1. Review your configuration and how triggers, context sources, and documentation platforms work for your team.

  2. Review suggestions together and publish your first documentation updates.

  3. Agree on what a successful pilot looks like for your team.

During the workshop, we define the success criteria for your pilot. These vary with each team’s needs. Across dozens of onboardings, though, suggestion volume and suggestion quality are the most reliable indicators that a team gets lasting value from Promptless.

Track how many suggestions Promptless creates. More suggestions aren’t always better, since too many can feel noisy. A steady stream of documentation suggestions shows that Promptless is plugged into the right parts of your workflow.

Typical volume benchmarks by team size:

TeamTypical suggestions per month
0–1 people working full-time on docs20–40
2–5 technical writers30–100
Larger teamsDepends on how your team is organized. Consider setting a target for each product or product vertical you support.

If Promptless generates fewer than 20 suggestions a month, your team may be too early to see enough value from Promptless.

Rate Promptless’s suggestions on a scale from 0 to 10. Expectations differ from team to team, so your own rating is the measure. The target is for Promptless to consistently rate at least 8/10 for your team’s needs.

Use these descriptions to calibrate your ratings:

RatingWhat it means
9–10Most suggestions are relevant and can be accepted with few or no edits.
7–8Most suggestions are accurate and relevant and need only moderate editing, such as refining style, adding specific details, or adjusting tone. Promptless meaningfully reduces your documentation workload.
4–6Suggestions sometimes catch relevant changes and serve as a starting point. They need significant editing, such as rewriting content, fixing inaccuracies, or filling in missing context. Promptless saves some time without changing your workflow much.
0–3Promptless creates negative value. Most or all suggestions aren’t a useful starting point, and even when they flag something relevant, you’d rather start from scratch.

After your onboarding workshop, we schedule 15–30 minute weekly check-ins to track progress and address issues. Each check-in reviews:

  • How many suggestions Promptless created
  • How you’d rate suggestion quality this week, from 0 to 10
  • The gap between current suggestions and 10/10 quality
  • How Promptless fits into your workflows, and whether it triggers at the right times

We use these check-ins to find and fix issues, adjust your configuration, and make sure you’re getting value from Promptless.

To discuss your pilot, contact us at help@gopromptless.ai.