Agent WranglersReference and changelogs
Keep docs for every supported version, give each error and setting a generated page, and log deprecations, security fixes and migrations.
- Recommended 5
Recommended
Keep a docs version for every supported release
DOC-11Publish a separate docs version for every major version you still support. Show a banner on older versions that links to the same page in the latest one.
Give every error code its own docs page
DOC-12Give every error code or problem type your product returns a docs page that says what it means and how to fix it. Link to that page from the error itself.
Generate the settings reference from one schema
DOC-13Define every setting and environment variable once, in a schema in the code, with its type, default and description. Generate the settings reference from that schema.
Log deprecations and security fixes in their own sections
DOC-14Give the changelog the six change types Added, Changed, Deprecated, Removed, Fixed and Security, with an ISO 8601 date per release. Mark a pulled release as yanked.
Write a migration guide for every major version
DOC-15Publish a migration guide with every major version. List each breaking change with the old use, the new use and how to find affected code.
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/reference-and-changelogs">Agent Wranglers documentation playbook</a>. In code you write, add a comment next to it with the same link.