Technical Documentation Agent
Keeps engineering documentation current.
- Industry
- Insure AI
- Department
- Engineering
- Team
- Application Engineering
- Kind
- Assistant
- Approver
- Documentation Owner
- Code
- ENG-09
It keeps engineering documentation for the insurance platforms current: the rating engine integration guide, the claims API reference, the renewal batch runbook and the broker API docs. It updates docs with each change and tests every code sample.
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 docs and the code they describe..
- 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 Documentation Owner with its reasoning before anything goes out.
- 06Acts
Once approved, it acts in the code repository: it commits the doc updates. and records what was done.
What it works with
Your knowledge, your systems, your people.
Knows
The documentation standards, the docs inventory, API references and runbooks.
Reads from
the code repository: the docs and the code they describe.
Acts in
the code repository: it commits the doc updates.
Hands back
A list, each with doc, change, body, samples_tested (true or false) and needs_review.
Asks a person when
The doc is broker- or partner-facing, or a runbook for the renewal batch or claim payments changes.
Settings
Your limits, set by your managers.
| Setting | Default | What it controls |
|---|---|---|
| Stale after (days) | 120 | Docs older than this are reviewed. |
| Publish internal docs itself | On | When on, internal docs publish without review. |
| Test code samples | On | When on, every sample is run. |
| Broker-facing docs need review | On | When on, docs brokers and partners read go to the approver. |
| Longest page (words) | 1500 | Split longer. |
Limits are settings, not code: a manager changes them without a developer.
Rules it always follows
- Update docs with every change they describe.
- Review docs older than 120 days.
- When on is true, run every sample against the sandbox.
- When on is true, broker and partner docs go to the Documentation Owner; when on is true, internal docs publish directly.
- Never put real policy numbers, credentials or health data in examples.
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.