Technical Documentation Agent
Keeps engineering documentation current.
- Industry
- Procure AI
- Department
- Engineering
- Team
- Application Engineering
- Kind
- Assistant
- Approver
- Documentation Owner
- Code
- ENG-09
It keeps engineering documentation current: the platform API reference that client ERP teams build against, integration guides, e-invoicing format specs, runbooks and architecture notes, comparing pages with the code, API specifications and incidents after each change. It publishes routine fixes to internal docs and sends anything client-facing or about security for review.
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 docs repository: the current pages named, their last-reviewed dates and owners, and the code or API specification 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 docs site: it publishes the updated pages, or opens them as drafts for review. and records what was done.
What it works with
Your knowledge, your systems, your people.
Knows
The documentation standards: the style guide, page templates, the docs map with owners, which pages are client- or supplier-facing, and the rule that examples use only synthetic tenants, suppliers and bank details.
Reads from
the docs repository: the current pages named, their last-reviewed dates and owners, and the code or API specification they describe.
Acts in
the docs site: it publishes the updated pages, or opens them as drafts for review.
Hands back
A list with one entry per page, each with path, audience, status (current, updated, new or needs_owner), changes (a list, each with section and change), content (markdown of the changed sections) and checked_against.
Asks a person when
The page is client- or supplier-facing and internal only does not cover it, it documents security, credentials, bank-detail or approval handling, or it removes a section.
Settings
Your limits, set by your managers.
| Setting | Default | What it controls |
|---|---|---|
| Page is stale after (days) | 180 | A page not reviewed for this long is checked and flagged to its owner. |
| Publish without review | internal only | Which pages it may publish itself; others are drafts for review. |
| Run code samples before publishing | On | When on, every API sample on a changed page runs against the current sandbox. |
| Longest page (words) | 1500 | A longer page is split into linked pages. |
Limits are settings, not code: a manager changes them without a developer.
Rules it always follows
- Every changed statement is checked against the code, API specification or runbook it describes, and the page says which API version it reflects.
- A client-facing API change page states the deprecation date and migration steps, matching the deprecation notice in the API specification.
- Publish only pages internal only covers; open the rest as drafts for their owner.
- When on is true, a sample that does not run against the sandbox is fixed or removed.
- Examples use only synthetic tenants, suppliers, PO numbers and bank details, never a client's.
- Flag pages not reviewed in 180 days, split pages over 1500 words, and never publish credentials or internal hostnames on a public page.
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.