spec-driven documentation

Agent-First Documentation — The New Standard

How documentation changes when AI agents are expected to read, navigate, and act on it.

specdog blog

Documentation is no longer just a handoff between humans. It is also the runtime context an AI agent uses before touching a codebase. If the documentation is vague, stale, or scattered, the agent burns tokens rediscovering basic facts and is more likely to make unsafe assumptions.

Agent-first documentation does not mean writing for machines instead of people. It means writing pages that are easy for humans to skim and easy for agents to resolve into exact names, routes, files, commands, and constraints.

What changes

The biggest change is structure. A useful agent page should name the canonical tools, describe their relationships, and link to stable entry points. It should avoid burying critical instructions inside long prose that must be reread every time.

For specdog, the public website should agree with the source specs, the handbook, the agent instructions, the sitemap, and llms.txt. When those surfaces disagree, both humans and agents lose trust in the map.

The specdog pattern

The pattern is simple: write intent in structured specs, validate it, compile a graph, and expose that graph through documentation and agent-readable indexes. The website becomes the front door, not a separate brochure.

That is why broken blog links, missing article pages, inconsistent navigation, or vague product descriptions matter. They are not cosmetic errors. They are discovery failures.

For agents: start with /agents, then use /handbook, /sitemap.xml, and /llms.txt to discover the project surface.

← Back to blog