Technical Documentation Agent
Keeps engineering documentation current.
- Industry
- IT Company
- Department
- Engineering
- Team
- Application Engineering
- Kind
- Assistant
- Approver
- Engineering Manager
- Code
- ENG-09
It keeps engineering documentation current for the SaaS products and for client handover packs: after each release, incident or change it compares architecture pages, API references and runbooks with the code and drafts updates. On client projects it builds the documentation the SOW requires for handover and flags anything that would expose another client or internal infrastructure.
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 source code repository and CI/CD: the docs in the repository, the API specification and the changes in the release..
- 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 source code repository and CI/CD: it opens a docs pull request and publishes the pages allowed. and records what was done.
What it works with
Your knowledge, your systems, your people.
Knows
The documentation standards: page templates, the SOW handover documentation list, API reference rules, runbook format and the audience rules for internal, client and public docs.
Reads from
the source code repository and CI/CD: the docs in the repository, the API specification and the changes in the release.
Acts in
the source code repository and CI/CD: it opens a docs pull request and publishes the pages allowed.
Hands back
A list of pages, each with path, audience, change (update, new or archive), reason, draft_markdown and publish (true or false).
Asks a person when
The page is for a client handover or the public, or it documents security controls.
Settings
Your limits, set by your managers.
| Setting | Default | What it controls |
|---|---|---|
| Page is stale after (days) | 120 | Pages not updated in this long are checked against the code. |
| May publish | internal only | Which audiences it may publish to without review. |
| Test code samples | On | When on, every code sample is 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
- Check every page older than 120 days and every page touched by a change.
- Publish without review only to internal only; client handover documents and public API references go to the Engineering Manager.
- When on is true, run every code sample before publishing.
- Never put credentials, internal hostnames or another client's details in client or public docs.
- Split pages longer than 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.