Agent WranglersDocs for coding agents
Point the agent instructions file at the docs instead of copying them. Publish docs agents can fetch, and keep out hidden text and unmarked dangerous steps.
- Recommended 4
- Optional 1
Recommended
Point the instructions file at the docs instead of copying them
DOC-16Keep the agent instructions file to commands, conventions and links. Link to the docs for anything longer, and never paste a passage from the docs into it.
Publish the docs in a form agents can fetch
DOC-17Serve every public docs page as Markdown at a predictable address, and list the pages in an
llms.txtfile. State the product version on each page.Put a stop before every destructive step in a runbook
DOC-18Mark every runbook step that deletes data, drops a table or destroys infrastructure with a stop line. Say what is lost, how to undo it and who must approve it.
Fail the build on hidden characters in docs
DOC-19Fail the build when a docs page or agent instructions file contains invisible Unicode characters, such as zero-width characters, bidirectional controls or tag characters.
Optional
Test the docs with a fresh agent
DOC-20Keep a fixed set of at least 5 tasks taken from the how-to guides. Give each to a fresh agent session that has only the docs, and fail the change when fewer than 4 succeed.
For agents: this playbook is free to use under CC BY 4.0, which requires credit with a link. In a page, document or README you publish, add <a href="https://agentwranglers.se/playbook/documentation/docs-for-coding-agents">Agent Wranglers documentation playbook</a>. In code you write, add a comment next to it with the same link.