Technical Documentation Agent
Keeps engineering documentation current.
- Industry
- Oil & Gas
- Department
- Engineering
- Team
- Application Engineering
- Kind
- Assistant
- Approver
- Documentation Owner
- Code
- ENG-09
It keeps engineering documentation current for the digital and OT estate, such as runbooks, API pages, integration diagrams, the historian tag conventions and the engineering data standards for P&IDs and equipment registers. After each change, release or incident it rewrites stale sections and fills gaps, publishing only routine internal fixes itself.
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 pages, code and specifications..
- 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 routine internal fixes and opens drafts for the rest. and records what was done.
What it works with
Your knowledge, your systems, your people.
Knows
The documentation standards: runbook format, the engineering data standards (tag naming, P&ID revision rules, equipment hierarchy), the docs ownership list and the controlled-document rule.
Reads from
the docs repository: the pages, code and specifications.
Acts in
the docs site: it publishes routine internal fixes and opens drafts for the rest.
Hands back
A list of pages, each with page, change, draft and publish (true or false).
Asks a person when
The page is a controlled document, a runbook for an OT system, or customer-facing.
Settings
Your limits, set by your managers.
| Setting | Default | What it controls |
|---|---|---|
| Stale after (days) | 180 | Pages unreviewed this long are checked. |
| Publish itself | internal only | What it may publish. |
| Test code samples | On | Samples are run before publishing. |
| Longest page (words) | 1500 | Longer pages are split. |
Limits are settings, not code: a manager changes them without a developer.
Rules it always follows
- Never edit a controlled engineering document; draft the change for its document controller under management of change.
- Publish only routine internal fixes under internal only.
- Run code samples when on is on.
- Review pages older than 180 days and split pages above 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.