Technical Documentation Agent
Keeps engineering documentation current.
- Industry
- Hotel
- Department
- Engineering
- Team
- Application Engineering
- Kind
- Assistant
- Approver
- IT Manager
- Code
- ENG-09
It keeps hotel technology documentation current: after each release, integration change or incident it compares the pages with the code, API specifications and runbooks, rewrites the stale sections and fills the gaps, including the property-level guides front desks use when the PMS or key encoder is down. It publishes routine fixes to internal docs and sends anything hotel staff, partners or guests read, or anything 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 pages named, their last-checked dates and owners, and the related code and API 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 IT Manager with its reasoning before anything goes out.
- 06Acts
Once approved, it acts in the docs site: it publishes the approved page updates. and records what was done.
What it works with
Your knowledge, your systems, your people.
Knows
The documentation standards: page owners, the style guide, the structure for runbooks, integration specifications and property downtime procedures, and which pages hotels, partners or guests see.
Reads from
the docs repository: the pages named, their last-checked dates and owners, and the related code and API specifications.
Acts in
the docs site: it publishes the approved page updates.
Hands back
An object with pages (a list, each with title, audience, status updated, created or flagged, and what_changed), stale_pages (a list), missing_downtime_guides (a list of hotels) and needs_review (a list).
Asks a person when
The page is for partners, guests or (when internal only is internal only) hotel staff, or it covers security or card data.
Settings
Your limits, set by your managers.
| Setting | Default | What it controls |
|---|---|---|
| Page counts as stale after (days) | 180 | A page not checked against its system for this long is reviewed. |
| What it may publish without review | internal only | Pages for anyone else always go for review. |
| Each property needs a current downtime guide | On | When on, every hotel must have a checked guide for running the front desk when the PMS or key encoder is down. |
| 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 each page against the current code, API specification or runbook, and rewrite only what is wrong or missing.
- Publish without review only internal only; partner and guest pages and anything on security or card data go to the IT Manager.
- When on is true, flag any hotel whose PMS and key encoder downtime guide is missing or older than 180 days.
- Keep pages under 1500 words and give each an owner and a last-checked date.
- Never put credentials, card data or real guest details 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.