How do we move forward as a documentation community to create agent-friendly docs that the new era of coding agents can consume and benefit from?
We make a spec! And we implement tools that can validate our docs against the spec.
I'm proposing the Agent-Friendly Documentation Spec - at the time of writing this post, it's 21 checks across 8 categories, but I keep adding new ones 😁
This is my attempt to turn observation and research into the minimum, practical, mechanical guidelines required to make docs agent friendly across these categories:
- llms.txt
- Markdown availability
- Page size
- Content structure
- URL stability
- Agent discoverability
- Observability
- Authentication
I'm sure there are more things I haven't considered yet, so help me brainstorm, technical writing hive mind... what else should be here? The website links to a GitHub repo. Please file issues and let's start talking about how this can serve all of us as we look to make our docs more coding-agent-friendly.