read-the-damn-docs

Forces web searches of official documentation before implementing or debugging external APIs.

1|1|Updated Nov 25, 2024
One-click install
npx skills add https://github.com/joeledwardson/dev-setup --skill read-the-damn-docs-joeledwardson
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: read-the-damn-docs
Source: https://github.com/joeledwardson/dev-setup/tree/main/configs/claude/skills/read-the-damn-docs
Command: npx skills add https://github.com/joeledwardson/dev-setup --skill read-the-damn-docs-joeledwardson

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? AI agents often rely on stale model memory when working with third-party APIs, libraries, and frameworks, producing outdated imports, deprecated config, and wrong assumptions. This Skill enforces a docs-first discipline so answers and code are grounded in current official documentation. ## Core Features & Use Cases - Docs-First Triggers: Defines explicit conditions (version-sensitive APIs, auth, billing, migrations, deprecations) that require reading docs before coding. - Authoritative Source Hierarchy: Prioritizes local repo docs and specs, then official product docs, changelogs, and package registry version checks over blog posts or memory. - Required Workflow: A seven-step process from identifying the exact surface to verifying with typechecks or tests and citing the docs used. - Use Case: When asked to add Stripe webhooks or stream responses with an AI SDK, the agent first web-searches the current official docs, verifies the latest package version, and implements against the documented contract. ## Quick Start Ask the agent to add a third-party integration like Tailwind or Stripe webhooks and require it to check the current official docs before writing any code.

Frequently Asked Questions about read-the-damn-docs

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

FAQPage Schema
How do I stop an AI agent from using outdated API knowledge?

Use a docs-first workflow that requires the agent to web-search current official documentation before coding. This Skill defines triggers for version-sensitive tasks and mandates reading primary docs instead of relying on model memory.

When should an agent search the web for documentation?

Search when tasks involve third-party packages, fast-moving APIs, auth, billing, migrations, or requests for latest or current behavior. Skip it for trivial typo fixes, formatting, or self-contained local code already covered by tests and types.

What sources count as authoritative documentation?

Local repo docs, specs, schemas, and tests come first for internal contracts, followed by official product docs, API references, changelogs, and package registry metadata. Stack Overflow and old blog posts are only for debugging symptoms after the official contract is known.

Does this Skill verify package versions before installing?

Yes. Before adding a dependency, the workflow requires running commands like npm view <pkg> version to confirm the latest release, then reading the docs for that major version before writing imports, config, or install commands.

What happens if documentation is unavailable?

The agent must state plainly that docs could not be read before relying on memory. It should narrow uncertainty, inspect source code or type definitions if available, and avoid presenting the result as confirmed-current.