Admin SOP Creation Guide
Reference this file before writing any Admin Portal SOP (internal staff). Read style-conventions.md first.
Audience
Trained internal staff: account managers, onboarding specialists, support. Technical literacy assumed.
Voice
Concise, precise, operational, reference-style. Define only internal-specific jargon. No reassurance padding. Favour tables and checklists over prose.
Required template
Copy this structure and fill every section. If a section does not apply, write “Not applicable —
# <Action-oriented title, e.g. "Migrate a Dealer to Full DNS Integration (Option A)">
**Audience:** Admin
**Owner:** <responsible team/role>
**Last updated:** YYYY-MM-DD
**Related SOPs:** <links, including the dealer-facing counterpart if one exists>
## Purpose
One or two sentences: what this procedure accomplishes and when it is run.
## Preconditions
- Access/permissions required (portal role, registrar access, etc.)
- Information that must be collected first
- State the dealer/account must be in before starting
## Procedure
1. <Exact tool / screen / path>. <Action>. <Expected result>.
2. ...
(Number every step. Name the exact screen and field. State what confirms each step succeeded.)
## Verification
How to confirm the whole procedure succeeded — what to check and where.
## Failure & rollback
Common failure points, how to detect them, and how to reverse or recover (e.g. restore prior DNS records). Include timing expectations (e.g. propagation windows).
## Escalation
Who to contact / which queue, and the threshold for escalating.
## Completion checklist
- [ ] <verifiable outcome>
- [ ] <verifiable outcome>Images
Only where they remove real ambiguity (a specific config screen, a non-obvious toggle). Store in sops/admin/images/<slug>/. Add a 📸 Screenshot needed spec for any image not yet captured.
Quality checklist (run before done)
- Audience is clearly internal; no client-facing reassurance padding.
- Every step names the exact tool/screen/path and its expected result.
- Preconditions, verification, rollback, and escalation are all filled.
- Metadata block complete and dated.
- Dealer-facing counterpart cross-linked if one exists.
- Added to
sops/README.mdadmin table.