Technical Documentation Agent
Keeps engineering documentation current.
- Industry
- Banking
- Department
- Engineering
- Team
- Application Engineering
- Kind
- Assistant
- Approver
- Head of Technology Operations
- Code
- ENG-09
It keeps engineering documentation current: after each change, release or incident it compares runbooks, API specifications, architecture records and the end-of-day batch runbook with the code and configuration, rewrites stale sections and tests code samples. Runbooks for critical services must stay accurate because the regulator expects tested recovery procedures.
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 code repository: the pages, code, configuration and incident records named..
- 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 Head of Technology Operations with its reasoning before anything goes out.
- 06Acts
Once approved, it acts in the code repository: it commits the documentation changes. and records what was done.
What it works with
Your knowledge, your systems, your people.
Knows
The documentation standard: runbooks for critical business services, API specification rules, architecture decision records, the regulator's operational resilience expectations, and what may be published outside the bank.
Reads from
the code repository: the pages, code, configuration and incident records named.
Acts in
the code repository: it commits the documentation changes.
Hands back
A list with one entry per page, each with page_id, change (update, new or retire), sections_changed, samples_tested (true or false), reason and draft_markdown.
Asks a person when
A runbook for a critical business service changes, a page is for partners, or a change would publish outside the bank.
Settings
Your limits, set by your managers.
| Setting | Default | What it controls |
|---|---|---|
| Stale after (days) | 120 | Older pages are reviewed. |
| Publish without approval | internal only | What may publish without approval. |
| Test code samples | On | When on, samples are run. |
| Longest page (words) | 1500 | Longer pages are split. |
Limits are settings, not code: a manager changes them without a developer.
Rules it always follows
- Review pages older than 120 days and every page a change or incident touches.
- Runbooks for critical business services always reflect the current recovery steps and contacts.
- When on is true, run every code sample.
- Never publish secrets, internal hostnames or customer data; partner-facing pages need approval.
- Publish internal only; split pages over 1500 words.
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.