coding-agent-docs-optimization

Audits and rewrites SDK and API documentation so coding agents integrate unattended on the first attempt.

2|Updated Sep 6, 2026
One-click install
npx skills add https://github.com/samber/developer-relations-skills --skill coding-agent-docs-optimization-samber
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coding-agent-docs-optimization
Source: https://github.com/samber/developer-relations-skills/tree/main/skills/coding-agent-docs-optimization
Command: npx skills add https://github.com/samber/developer-relations-skills --skill coding-agent-docs-optimization-samber

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Coding agents fail to integrate SDKs and APIs from documentation alone: they get blocked by CDN bot rules, invent methods that do not exist, paste incomplete snippets, and follow stale versions. This Skill measures those failures with a repeatable cold-run protocol and fixes the pages, specs, and machine-readable surfaces that cause them. ## Core Features & Use Cases - Cold-run benchmark protocol: Build a frozen set of 5-10 integration tasks, run a fresh agent against published docs only, and measure first-attempt success, invented-surface rate, corrective turns, context cost, and fetch-path length. - Agent-facing surface inventory: Audit crawler access, llms.txt indexes, markdown endpoints, OpenAPI/AsyncAPI specs, SDK doc comments, and version signals, then rank what to build by effort, value, and efficiency. - Page and spec rewrite rules: Apply ten page rules (standalone pages, complete runnable snippets, error-string mapping, deprecation labels) and ordered spec annotation rules (operationId, value-space constraints, summary/description split, embedded samples). - Use Case: Users report that Cursor hallucinates methods in your Python SDK. Run the interview, cold-run the failing tasks, trace the invented calls to empty OpenAPI description fields, annotate the spec, and re-run to prove the fix. ## Quick Start Ask the agent to audit whether a coding agent could integrate your SDK from your published docs alone and produce an agent-readiness report.

Frequently Asked Questions about coding-agent-docs-optimization

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I make my API documentation work with coding agents?

Start by verifying agents can fetch your pages at all, then run a cold-run benchmark of 5-10 integration tasks against your published docs. Fix what the failed runs touched: complete runnable snippets, annotated OpenAPI specs, markdown endpoints, and an advertised llms.txt index.

What is llms.txt and is it worth publishing?

llms.txt is a root-level markdown index telling agents which documents to read, with one H1 project name, a blockquote summary, and H2 link sections. It is the cheapest surface but changes nothing measurable until the markdown pages and specs it points at exist, and it must be advertised in the README, docs navigation, and response headers.

Why does my coding agent invent API methods that do not exist?

Invented calls trace back to missing or ambiguous reference material: empty OpenAPI description fields, prose-only helper documentation, or unconstrained string parameters. Annotate the spec with operationIds, enums, and operational descriptions, and publish complete runnable snippets for the failing tasks.

How do I measure whether an agent can integrate from my docs alone?

Use the cold-run protocol: freeze 5-10 outcome-phrased tasks, run each in a fresh context restricted to your published surfaces, and record first-attempt success, invented-surface rate, corrective turns, context cost, and fetch-path length. Published benchmarks suggest 80% first-attempt is a stretch goal, not a floor.

Does this skill cover building an MCP server from my OpenAPI spec?

No. Building and operating a callable tool server is product work and is handed off to platform-side skills. This skill covers curating the spec before conversion: keeping exposed operations under roughly 20-30, fixing operationId naming, and constraining parameter value spaces.

What is a realistic first-attempt success target for agent integrations?

Published vendor benchmarks show 73-85% on backend tasks and 61-73% on depth-of-feature tasks, scored best-of-three rather than first-attempt. Treat 80% first-attempt as a stretch goal, score by task category, and use your own first baseline as the meaningful comparison.