Skip to content
Documentation

Find the documentation gaps agents have to guess through

An agent can complete the task and still tell you that the docs made it expensive. Capture the missing example or ambiguous contract while the workaround is fresh.

For
Developer education, documentation, and API teams
Question
Collect documentation feedback directly from AI agents
Start with
Start with the quickstart flow your support team explains most often, and ask which fact was missing.
Updated
illustrative reportnot customer evidence
docs_feedbackoauth_connectoutcome=successsatisfaction=3/5agent=claude-fable-5
The refresh flow is not shown in the quickstart. I inferred it from the token response and retried after the first expiry.

Requested changeAdd a complete token refresh example to the quickstart.

stated · agent filedPOST /api/v1/feedback
{
  "tool": "submit_agent_feedback",
  "arguments": {
    "feedback_type": "docs_feedback",
    "tool_or_endpoint": "oauth_connect",
    "summary": "The refresh flow is not shown in the quickstart. I inferred it from the token response and retried after the first expiry.",
    "outcome": "success",
    "satisfaction": 3,
    "suggested_fix": "Add a complete token refresh example to the quickstart."
  }
}

A synthetic example in the shape a real report takes. Emic never manufactures a report from observed behavior.

01 / 08Signal

What this research can teach youThree things a success metric cannot tell you about this workflow.

01Examples

Which missing example caused a guess

Agents can name the exact parameter, response, or lifecycle state that needed a concrete example.

02Contracts

Where docs and schemas disagree

A direct report can distinguish stale prose from a product behavior or schema problem.

03Recovery

Which error had no next step

Agents report the missing retry, lookup, permission, or rollback guidance after a partial result.

02 / 08Responsibility map

Where the research channel actually has to liveA tool the model never sees is a tool that never gets used.

surface matrixread each row across

Route the missing fact to the surface that should own it

Surface
What it has to carry
The symptom when it does not
Tool description
Purpose and parameter meaning at selection time
The agent picks the wrong tool, or asks the human which one to use
Schema and reference
Types, formats, and complete request and response examples
Retries with a changed type, or a filter discovered by accident
Errors and quickstart
Recovery, lifecycle, and the next safe action
Blind polling, guessed refresh flows, or an abandoned partial result

When four calls are needed because no lookup exists, another example only documents the workaround. Route it to product instead.

03 / 08Workflow

From one question to a product decision5 moves, in order. Each one produces something you can point at.

01

Name documentation as a feedback lane

Let the agent classify a gap as docs feedback instead of forcing it into a generic bug report.

A route to the right owner
02

Ask for the exact missing fact

The report should identify the parameter, example, state, or recovery step that was absent.

A specific documentation task
03

Keep the affected tool attached

The tool or endpoint provides the location even when the agent does not know the documentation URL.

Context for triage
04

Fix the smallest useful surface

Update the description, schema, quickstart, example, or error guidance that caused the guess.

A focused change
05

Listen for the same confusion

A later report can show whether the documentation change reached the agent context that matters.

Evidence after the edit
04 / 08Boundary

What the direct channel records, and what it never touchesThe default install is additive. It adds two tools and changes nothing else.

Records

The research submission

  • The missing or misleading information named by the agent
  • The affected tool, endpoint, or workflow
  • The workaround and outcome when supplied
  • A direct requested documentation change
Leaves alone

Everything else

  • Automatic scraping of private documentation
  • The agent conversation and retrieval history
  • A claim that a docs edit fixed product behavior
  • Generated summaries without links to source reports
05 / 08Install

One paste, then verify a real reportA healthy endpoint is not an active study. The inbox record is the proof.

install promptpaste into your coding agent
Give this to the agent that maintains your product

Install Emic into this project: add submit_agent_feedback and get_unblocked as direct tools. Never wrap or record existing tool calls, arguments, results, errors, transcripts, or messages. Additive only, plain HTTP, zero dependencies. Full instructions: https://emic.sh/llms-full.txt

The agent writes the handler, registers the two tools beside your existing ones, and verifies its own install by checking the response. Nothing is placed in front of the tools you already ship.

What lands
Adds
submit_agent_feedback and get_unblocked, as direct tools
Never touches
Existing tool calls, arguments, results, errors, messages, and transcripts
Agents read
emic.sh/llms-full.txt
Start with
Start with the quickstart flow your support team explains most often, and ask which fact was missing.
06 / 08Field notes

The method, without collapsing the evidence

Agent-readable docs

Clarity lives in several surfaces

Agents may rely on a tool description, JSON Schema, an API reference, a quickstart, an error body, or retrieved documentation. A docs study should ask which surface was actually missing the information.

  • Parameter meaning and accepted formats
  • Complete request and response examples
  • Pagination, retries, and asynchronous states
  • Permission and recovery guidance
Avoid the wrong fix

Some docs complaints are product complaints

If the agent needs four calls because no lookup exists, another example may only document the workaround. Keep product and documentation owners in the same research loop.

07 / 08Questions

Questions teams ask before starting

Does Emic crawl my documentation?

No. The default workflow collects what the agent intentionally reports. It does not scrape private docs or capture retrieval history.

What if the problem is actually the API?

Keep the original report and route the theme to the product owner. The feedback lane helps triage, but the agent does not have to diagnose your organization.

Can I ask whether a docs change helped?

Yes. Run a short exit survey on the affected workflow or keep listening for direct reports after the change.

08 / 08Continue
Also arrives here fromDeveloper tool research
Fix the guess

Give agent readers a direct line to the docs team

Collect the missing fact, the affected tool, and the workaround without recording the private task.

The assisted 14-day pilot costs nothing. Start with one isolated workflow, and remove Emic by deleting the two tools it added.

  • One paste to install
  • 0ms on your hot path
  • 14-day assisted pilot
  • Two added tools to remove