How Promptless Learns Your Docs

Before creating the first suggestion, Promptless analyzes your existing docs to understand the product, writing style, and how your docs are organized.

Initial Ingestion

• Builds a searchable index to find relevant content when analyzing triggers
• Maps relationships between pages, sections, and topics

Product Ontology

Promptless builds an understanding of your product’s structure - what features you have, how they relate to each other, and the terminology your team uses. This product ontology helps Promptless:

• Know which documentation pages are relevant when a specific feature changes
• Understand your product’s concepts and terminology
• Identify connections between features that might require coordinated documentation updates

For example, if your product has a “Workspaces” feature with sub-features like “Permissions” and “Invitations,” Promptless understands these relationships and can update all relevant pages when workspace behavior changes.

Voice and Style Learning

Promptless analyzes how your documentation is written - tone, sentence structure, formatting patterns, and terminology choices. This powers Voice Match, ensuring suggestions sound like they were written by your team.

Promptless learns patterns like:

• Whether you write formally or conversationally
• The specific words and phrases you use for concepts
• How you organize content, use headings, and format examples
• Your preferences for capitalization, punctuation, and code formatting

When drafting content, Promptless references similar existing pages to match their style.

Continuous Learning

Promptless continues learning as you use it. When you edit suggestions or provide feedback, Promptless learns your preferences for future suggestions. As your documentation grows and changes, Promptless adapts to your evolving style and automatically re-indexes when you publish updates to stay current.

Custom Agent Instructions with AGENTS.md

You can provide persistent guidance to Promptless by creating an AGENTS.md file in the root of your docs repository. Use this file to specify project-specific conventions, terminology, and documentation standards that the agent follows when creating suggestions.

How It Works

When Promptless starts working on your documentation, it checks the root of your docs repository for an AGENTS.md file. If found, the content is included in the agent’s instructions, applying your custom guidance to every suggestion.

What to Include

Use your AGENTS.md file to communicate:

• Terminology preferences - Specific words or phrases your team uses for concepts
• Formatting conventions - How to structure code examples, callouts, or headings
• Content guidelines - What information should always be included (or excluded)
• Style rules - Voice, tone, or writing patterns unique to your documentation

Example AGENTS.md

# Documentation Guidelines

## Terminology
- Use "workspace" not "project" when referring to user containers
- Always capitalize "API" but lowercase "endpoint"
- Prefer "authentication" over "auth" in prose

## Formatting
- Use admonitions for warnings and important notes
- Include a "Before you begin" section in procedural docs
- Code examples should include comments explaining each step

## Style
- Write in second person ("you") rather than third person
- Keep sentences under 25 words when possible
- Use active voice

Relationship with CLAUDE.md

If your repository already has a CLAUDE.md file (used by Claude Code CLI), Promptless uses that instead. The AGENTS.md file is only loaded when no CLAUDE.md is present, maintaining compatibility with existing Claude Code configurations.