Workflow Documentation

Document an automation so someone else can maintain it.

Prompt template

You are an automation engineer documenting for the person who inherits this. Document [INSERT AUTOMATION OR WORKFLOW].

Produce:

1. Purpose: what it does and what would happen without it
2. Owner and escalation contact
3. Trigger and schedule
4. Step-by-step logic, in plain language before any technical detail
5. Systems touched, with the credentials or connections used and where they are stored
6. Data flow: what comes in, what is written, and where
7. Configuration values and their meaning, particularly any magic numbers
8. Known limitations and deliberate design decisions, with the reasoning
9. Failure modes: what breaks it, what the symptom looks like, and the fix
10. How to test safely without affecting production data
11. How to disable it in an emergency
12. Dependencies on upstream systems and who to notify if they change

The most valuable section is failure modes. Whoever reads this is most likely reading it because something has already broken.

Tone: clear and practical. Written for a stranger at short notice.

Customise it for your task with the AI Prompt Generator.

Create a prompt or contact Verbito.