Technical Documentation Agent
Keeps engineering documentation current.
- Industry
- Retail
- Department
- Engineering
- Team
- Application Engineering
- Kind
- Assistant
- Approver
- Engineering Manager
- Code
- ENG-09
It keeps engineering documentation current: service runbooks, integration specs, till and store system guides for store support, and the peak trading playbook. It updates the pages a change affects and flags docs that no longer match the system.
How it works
6 steps, and a person signs off before step 6.
- 01Looks it up
Finds the record the request is about in the engineering wiki: the pages for the subject and their review dates, and the linked change..
- 02Reads the request
Works out what is being asked and what a complete answer needs.
- 03Checks the facts
Checks figures, dates and rules against the source records, not from memory.
- 04Works it through
Prepares the draft, match, recommendation or reply, with its sources.
- 05Asks a person
Hands the work to Engineering Manager with its reasoning before anything goes out.
- 06Acts
Once approved, it acts in the engineering wiki: it updates or creates the pages as drafts for the owner to publish. and records what was done.
What it works with
Your knowledge, your systems, your people.
Knows
The engineering wiki: service and integration docs, store system support guides, the runbook template, the doc owners and the review dates.
Reads from
the engineering wiki: the pages for the subject and their review dates, and the linked change.
Acts in
the engineering wiki: it updates or creates the pages as drafts for the owner to publish.
Hands back
A list with one entry per page, each with page, change (new, update or flag), content_markdown, reason and owner.
Asks a person when
The change rewrites the peak trading playbook, an incident runbook or a store support guide used during trading.
Settings
Your limits, set by your managers.
| Setting | Default | What it controls |
|---|---|---|
| Review docs older than (days) | 120 | Docs not reviewed in this long are flagged. |
| Write store guides in plain language | On | When on, store-facing guides avoid technical terms, for store staff. |
| Sections every runbook needs | owner, dependencies, alerts, common failures, rollback, escalation | Comma-separated. |
Limits are settings, not code: a manager changes them without a developer.
Rules it always follows
- Update every page the change affects, and link the change.
- Every runbook has owner, dependencies, alerts, common failures, rollback, escalation.
- When on is true, till and store system guides use plain steps that store staff can follow during trading.
- Flag docs older than 120 days or that contradict the code.
- Never put credentials, card data or shopper data in docs.
See the Technical Documentation Agent agent on your own work.
We’ll run it on a sample of your work and show you what your approver would see.