Skip to content

AI for business · Practical guide

Leave an automation that someone else can understand.

This guide proposes a short operating note and a handover exercise. The aim is to help another person recognise a successful run, locate a failure and ask for help without relying on the original builder’s memory.

By Eric Muriel3 min read
Pen on a black notebook on a wooden table.
Written agreements can be checked again later.Photo: Thomas Martinsen · Wikimedia Commons · CC0 1.0

01Describe what it does and where it stops

Fictional example: a workflow receives a request, checks its fields and prepares a draft for the support team. It does not send the reply to the customer. That last sentence marks a boundary someone might otherwise assume away.

Record the purpose, trigger, minimum input, expected output and excluded actions. Name the person who uses the output and the person who maintains the workflow. Record both roles if they belong to different people.

02Walk through an example

Save a valid fictional request and describe each step: receive it, validate fields, assign a category and create a draft. Record where to inspect the status and which identifier connects the input to the output.

Include classification rules and exceptions. If the workflow uses model instructions, identify where the active version lives. For connections, document required access and who can renew it, without copying passwords or keys into the note.

  • Trigger and minimum input.
  • Steps and rules applied.
  • Output and how to check it.
  • Operating and maintenance owners.

03Explain three failure situations

Rehearse an incomplete input, an unavailable connection and an output needing review. For each, describe how it is detected, where the work is left and who decides what happens next.

Do not make “run it again” a universal answer. First check whether a draft was already created or a record changed. Document which steps can be repeated and how to recognise earlier results to avoid duplicates.

Reference [1]: GOV.UK Service Manual

04Copy this operating note

Fields: workflow name; purpose; owner; actual last review date; trigger; example input; rules; expected output; status location; required connections; known errors; how to stop it; how to continue manually; checks before retrying.

Fill each field with a locatable instruction. “Check the error” does not say where. “Open the workflow history and find the request identifier” describes a usable path. Replace generic names with the names used in your environment.

05Test the handover without giving hints

Ask someone else to use the note with a valid fictional input and an incomplete one. Observe whether they find the output, identify the missing information and know whom to contact. Use the questions that force them to ask you for help to improve the document.

Repeat after changing a connection, rule or output. Keep a short record of what changed and why. For this exercise, a small note that reflects the current process is more useful than a long manual nobody has checked.

Sources and further reading

These references expand on the concepts indicated. The examples and exercises are original editorial material.

  1. [1] GOV.UK Service Manual

    Monitoring the status of your service ↗

    Service monitoring and recording issues.

    Back to the related section
How we use sources, quotes and images

Frequently asked questions

Do I need a special documentation tool?

A shared document or versioned file is enough for this exercise. The people operating the workflow need to know where to find it and be able to follow its instructions.

Where should credentials go?

Use your environment’s secret storage. In the note, record the connection name, required access and its owner, without including the key values.