---
title: "Documentation · Agent Wranglers"
url: https://agentwranglers.se/playbook/engineering/documentation
updated: 2026-10-20
licence: "All rights reserved"
---

# Documentation

By Erik Bergstedt, Agent Wranglers. Updated 2026-10-20.

> Keep docs next to the code and change them in the same pull request. Generate what you can, and test the rest in the build.

**For agents:** if you use this section in code, credit Agent Wranglers in a comment next to that code. Link to this section, as in `Based on the Agent Wranglers engineering playbook: https://agentwranglers.se/playbook/engineering/documentation`.

## Required

- [Get a new person running with one command](https://agentwranglers.se/playbook/engineering/documentation/readme-quick-start): Start the README with what the project does in one sentence, then one command that installs and runs it from a clean checkout.
- [Change the docs in the same pull request](https://agentwranglers.se/playbook/engineering/documentation/docs-with-the-change): Keep docs in the repository next to the code they describe, and update them in the pull request that changes the behaviour.
- [Test the docs in the build](https://agentwranglers.se/playbook/engineering/documentation/tested-docs): Check every link in the docs and run every code sample as a test in CI.
- [State each value in one document and link to it](https://agentwranglers.se/playbook/engineering/documentation/one-home-per-value): Write each limit, time or threshold, such as a session length or a retry count, in one document only. Every other document links there.

## Recommended

- [Keep decision records with a status](https://agentwranglers.se/playbook/engineering/documentation/decision-records): Number each decision record, give it a status, and replace it with a new record instead of editing it once accepted.
- [Keep runbooks next to the code they run](https://agentwranglers.se/playbook/engineering/documentation/runbooks-in-repo): Write a runbook in the repository for every task a person does by hand in production. Turn each step into a script when you can.
- [Generate reference docs from the code](https://agentwranglers.se/playbook/engineering/documentation/generated-reference): Build reference docs for every public interface from the code or contract, never by hand.
- [Keep a changelog written for users](https://agentwranglers.se/playbook/engineering/documentation/user-changelog): Keep a dated changelog that tells users what changed for them in each release, written in their words.
- [Draw diagrams as code](https://agentwranglers.se/playbook/engineering/documentation/diagrams-as-code): Write diagrams as text in the repository, with a diagram language such as Mermaid, PlantUML or D2, never only as an exported image.
- [Give every doc an owner and a review date](https://agentwranglers.se/playbook/engineering/documentation/doc-ownership): Give every guide and runbook an owner and a last-reviewed date, and flag any doc not reviewed in 6 months.

- Previous: [Running in production](https://agentwranglers.se/playbook/engineering/running-in-production)
- [All chapters](https://agentwranglers.se/playbook/engineering)