Productivity
process documentationSOPsknowledge managementoperationstrainingProcess Documentation Writer
Step-by-step process documentation clear enough for a first-timer to follow without asking a single question.
Best For
- •An ops manager documents the client-offboarding process so it survives when the one person who knows it goes on leave
- •A DevOps lead writes down the incident-response runbook so a first-time on-call engineer isn't guessing at 2am
- •A growing team turns a founder's tribal knowledge into documentation before hiring the role's first dedicated owner
Prompt Template
Write clear, step-by-step process documentation for: [PROCESS_NAME]. This process is performed by [ROLE, e.g., the account manager / the DevOps team] and occurs [FREQUENCY, e.g., weekly / whenever a new client is onboarded]. Process overview provided by the subject matter expert: [PROCESS_DESCRIPTION_OR_BRAIN_DUMP]. Structure the documentation as: (1) Process overview, purpose, who runs it, frequency, and estimated time to complete, (2) Prerequisites, tools, access, and information the person must have before starting, (3) Step-by-step instructions, numbered steps, each with: the action (imperative verb), the specific tool or location, the expected result/output, and a screenshot placeholder [SCREENSHOT: description] where visuals would help, (4) Decision points, if/then branches in the process with clear criteria for each path, (5) Common errors and fixes, top 3 mistakes made and how to recover, (6) Completion criteria, how does the person know they're done? Write for someone doing this process for the first time.
Pro Tip
Have the actual first-timer read the draft back to you before publishing, since gaps only surface when someone without the tribal knowledge tries to follow it step by step.
Example Output
A sample of what this prompt produces once you fill in the placeholders.
Process overview: client offboarding, run by the account manager whenever a client cancels, takes about 45 minutes. Prerequisites: access to the billing system and the client's project folder. Step 3: export the client's final invoice from the billing dashboard [SCREENSHOT: export button location], expected result is a PDF saved to the shared drive. Common error: forgetting to revoke API keys, which causes billing to continue silently.
How to use this prompt
- Copy the prompt template using the button above.
- Paste it into your preferred AI assistant (ChatGPT, Claude, Gemini, etc.).
- Replace all bracketed placeholders like
[TOPIC]with your specific details. - Send the prompt and refine the output as needed.