diff --git a/GLOSSARY.md b/GLOSSARY.md index fee9599..03a3f09 100644 --- a/GLOSSARY.md +++ b/GLOSSARY.md @@ -37,7 +37,7 @@ It is hidden for bots that take no input file. **Fake bot**: a bundled script that prints the Run tab protocol lines, used to verify the page. The skill never runs the real bot. -**Handover SOP**: the ` Handover SOP` the `rpa-bot-handoff` skill writes in a bot's repo (`HANDOVER-SOP.md` plus a Word copy), for the operator who runs the bot and does not read code. At most 4 pages, 5 sections in the operator's order: how to run, what you see while it runs, result, when something goes wrong, email us. See ADR-0005. _Avoid_: "ops guide" (the old 11-section format). +**Handover SOP**: the ` Handover SOP` the `rpa-bot-handoff` skill writes in a bot's repo (`HANDOVER-SOP.md` plus Word and PDF copies; ops get the PDF), for the operator who runs the bot and does not read code. At most 4 pages, 5 sections in the operator's order: how to run, what you see while it runs, result, when something goes wrong, email us. See ADR-0005. _Avoid_: "ops guide" (the old 11-section format). **Exception list**: the table in section 4 of the Handover SOP: one numbered row (`E01`...) per message the operator can see, with what it means and what to do, including when to email the dev team. diff --git a/docs/adr/0005-handover-is-a-short-sop.md b/docs/adr/0005-handover-is-a-short-sop.md index 993c680..e2f7f49 100644 --- a/docs/adr/0005-handover-is-a-short-sop.md +++ b/docs/adr/0005-handover-is-a-short-sop.md @@ -11,3 +11,5 @@ Supersedes ADR-0004. **Kept from ADR-0004:** the operator's words only, every wait is a number from the code, misleading statuses are called out where they show, the bot is never run, and the bot is checked for every common problem type. **Shorter skill (Oct 2026):** the user found the skill itself too detailed. SKILL.md is now a short checklist (under 500 words), the 12 Tebra failure classes are folded into 6 one-line "don't miss" checks, and the MEK Charge Reconciliation SOP (the 3-page PDF ops liked) replaces the Tebra example as the model. + +**One file (Oct 2026):** the user asked for about 50 lines. The skill is now one `SKILL.md` (under 60 lines) with the SOP shape inline, plus `templates/to_docx.py` for the Word and PDF. The template, the reference example and the README are removed. diff --git a/skills/rpa-bot-handoff/README.md b/skills/rpa-bot-handoff/README.md deleted file mode 100644 index 960d311..0000000 --- a/skills/rpa-bot-handoff/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# rpa-bot-handoff - -A Claude skill that writes a short **Handover SOP** for an RPA bot that is being handed over to an ops team. - -## What you get -**` Handover SOP.pdf`** (plus the `.docx` and `HANDOVER-SOP.md`): at most 4 pages, in plain words, for operators who don't read code: -1. How to run: the URL or shortcut, what to click, and what a new click does to the previous results -2. What you see while it runs: what shows where, a normal run, how long each step may take -3. Result: how a good run ends, where the report is, what each status means -4. When something goes wrong: how it shows, each message (E01, E02...) with what to do, the don'ts, how to stop it -5. Email us: To the developer, CC their manager, when to email, and the email to copy - -Problems the scan finds for the dev team are listed in the chat, not in the SOP. - -## Install -Copy this folder to `~/.claude/skills/rpa-bot-handoff/`. - -## Use -In your bot project, ask Claude: *"write the handover SOP for this bot"* or *"document this bot for handover"*. The skill: -1. Scans the code with a subagent. It never runs the bot. -2. Asks up to two things: the developer's and the manager's email (To and CC), and where ops runs the bot. -3. Writes the SOP, checks every quoted message and label against the code, and keeps it under 1,400 words. -4. Turns it into Word and PDF; you give the PDF to ops. - -## Files -| File | What it is | -|---|---| -| `SKILL.md` | Steps Claude follows | -| `templates/HANDOVER-SOP.md` | The SOP skeleton | -| `templates/reference/mek-charge-reconciliation.md` | The model SOP (MEK Charge Reconciliation, 3 pages) | -| `templates/to_docx.py` | Turns the SOP into Word, and with `--pdf` into PDF; prints word and page counts (`--selfcheck` tests it) | diff --git a/skills/rpa-bot-handoff/SKILL.md b/skills/rpa-bot-handoff/SKILL.md index 2ffb4fd..6c4dabd 100644 --- a/skills/rpa-bot-handoff/SKILL.md +++ b/skills/rpa-bot-handoff/SKILL.md @@ -5,27 +5,47 @@ description: Writes " Handover SOP" - a short PDF (at most 4 pages # RPA bot handoff -Make **` Handover SOP`**: one PDF, at most 4 pages, that ops keeps open while they run the bot. `templates/reference/mek-charge-reconciliation.md` is the model: copy its length, layout and tone. +Make **` Handover SOP`**: one PDF, at most 4 pages, that ops keeps open while they run the bot. Plain words, no code. -## Steps +1. **Scan.** One read-only subagent (never run the bot; no patient data, client names or passwords in its report). Ask for exact on-screen text with file:line: how to start (URL or shortcut, sign-in, Run button, what a new run does to old results), what shows where during a run, every timeout and retry, how a run ends and where the result is, every message ops can see, alerts, how to stop. +2. **Ask once:** the developer's email (To), the manager's name and email (CC), and where ops runs it if unclear. +3. **Write** `HANDOVER-SOP.md` in this shape: -1. **Scan.** Start one read-only subagent: never run the bot, no patient data, client names or passwords in its report. Ask for exact on-screen text with file:line: how to start (URL or shortcut, sign-in, Run button, what a new run does to old results), what shows where during a run, every timeout and retry, how a run ends and where the result is, every message the operator can see, alerts, and how to stop. -2. **Ask once:** the developer's email (To), the manager's name and email (CC), and where ops runs it if the code allows more than one place. -3. **Write** `HANDOVER-SOP.md` from `templates/HANDOVER-SOP.md`: 1. How to run, 2. What you see while it runs, 3. Result, 4. When something goes wrong, 5. Email us. -4. **Build** with `templates/to_docx.py`: `python /templates/to_docx.py HANDOVER-SOP.md -o " Handover SOP.docx" --pdf`. Over 4 pages: shorten cells, never drop a message. -5. **Hand over** the PDF. List problems for the dev team in at most 5 lines in the chat, not in the SOP. +```markdown +# Handover SOP +Version · · Problems: email , CC (section 5) + +## 1. How to run +Numbered steps: URL or shortcut, sign in, the Run button. Then "Before you click": what a new run does to the old results; one run at a time. +## 2. What you see while it runs +| Where on the screen | What it shows | then a normal run in one line +| Step | The bot waits at most | Then | then "Step in only when: ..." +## 3. Result +Good run / Needs a look (call out a misleading "Finished" or green). Where the result is. +| Status | Meaning | What you do | +## 4. When something goes wrong +How it shows (colour, list, column). Then: +| ID | Message you see | What it means | What you do | E01, E02 ... one row per message +Don't: (at most 3, with a short reason). To stop it: (the one right way). +## 5. Email us +Email with () in CC when section 4 says "email us". Answer: