GP-SOP-009 | Workflow Quality
Document a Workflow for Someone Else
Documentation that helps a new user understand, install, run, customize, and recover the workflow.
When to use this SOP
Use this when a workflow will be reused later, handed to a client, published, sold, or maintained by someone else.
What you need
- The tested workflow
- A clean installation path
- Sample input and output
- Known limitations and failure cases
The procedure
Follow these steps
- 01
Open with the problem, intended user, and finished outcome in plain language.
- 02
List required software, versions, accounts, credentials, models, hardware, and expected setup time.
- 03
Explain the architecture from trigger to output before documenting individual nodes.
- 04
Write installation steps in the exact order a new user must complete them.
- 05
Provide one realistic sample input and the expected output.
- 06
Identify safe customization points separately from required configuration.
- 07
Document common failures, how to recognize them, and how to recover.
- 08
Ask someone unfamiliar with the build to follow the guide without coaching.
Human checkpoint
Stop and review before continuing
Documentation should explain decisions and user actions, not narrate every obvious click or line of code.
Definition of done
- The value and audience are clear
- Requirements and setup time are honest
- Installation is reproducible
- Sample inputs and outputs are included
- Customization and troubleshooting are covered
- A new user completed the guide
When the process gets stuck
If the tester needs verbal help, add the missing assumption to the guide and repeat the test from a clean state.
Where automation fits
AI can turn accurate build notes into a first draft. It cannot discover undocumented dependencies that were never captured.
Optional AI assist
Use this after you collect the real inputs
This prompt can organize a first pass. Review the result against the SOP before using it.
Turn these verified build notes into workflow documentation. Include: - Problem and intended user - Outcome - Architecture overview - Requirements and realistic setup time - Installation - First run with sample input - Expected output - Safe customization points - Limitations - Troubleshooting - Unanswered questions for the builder Do not invent missing steps, versions, credentials, or test results. Flag gaps clearly. Build notes: [PASTE NOTES]