Documentation Standards
Best Practices in Process Documentation
Most process documentation is either too vague to be useful or too detailed to be maintained. Good documentation is neither. It captures exactly what someone needs to understand, execute, and govern a process — and nothing more. This framework defines the standard.
The Process Documentation Standard
Six Elements Every Process Document Must Have
Good process documentation has one test: can someone who has never done this process before execute it correctly using only this document? If the answer is no, the process documentation is incomplete. If someone who knows the process well can’t read it in under 10 minutes, it’s over-engineered.
| Element | What It Contains | Why It’s Required |
|---|---|---|
| Process Header | Name, version, owner, last reviewed date, applicable systems | Identifies the document and ensures it stays current |
| Trigger & Scope | What starts the process, what ends it, what it includes and excludes | Prevents scope creep and misapplication of the document |
| Role Map | Every role involved, their responsibilities, and decision authority | Eliminates ambiguity about who does what and who can approve |
| Process Flow | Step-by-step sequence with decision points — visual (Basic flow) + text | The core of the document — both visual and written versions serve different readers |
| Exception Handling | Documented path for every non-standard scenario | The most-used and least-documented section — where most operational problems live |
| Controls & Compliance | Validation steps, approval requirements, audit trail points, regulatory references | Required for regulated processes — makes compliance reviewable and auditable |
Attachments
The six elements above form the core document. For complex or multi-location processes, the following attachments extend the documentation to cover what the main document cannot fully capture inline. Each attachment is referenced from the relevant section of the core document.
| Attachment | What It Contains | When It’s Required |
|---|---|---|
| BPMN Diagram | Formal visual representation of the process flow using BPMN notation — events, tasks, gateways, swimlanes, and exception paths | Required for any process that will be automated, handed to a developer, or submitted for compliance review. Complements the written process flow in the core document. |
| Country gap mapping | A matrix documenting how the process differs across locations — regulatory variations, system differences, language or format requirements, and local exceptions | Required for any process operating across more than one country or jurisdiction. Without it, local teams adapt the process informally — creating undocumented variants that break automation. |
| Form mock-ups with field descriptions | Visual mock-ups of every form, screen, or data entry point in the process — including field names, data types, validation rules, mandatory vs optional fields, and source systems | Required when the process involves data capture, user input, or form-based workflows. Critical for UI design, system integration, and ensuring automation handles data correctly at every step. |
| Integration map | A structured list of all systems the process connects to — APIs, databases, file transfers, third-party platforms — with data direction, trigger conditions, error handling, and authentication method | Required for any process that reads from or writes to external systems. Without a documented integration map, developers build to assumptions and compliance teams cannot verify data flows. |
Quality Criteria
Good vs Poor Process Documentation
✓ Good Process Documentation
- ✓Describes what actually happens, not what should
- ✓Includes exception paths, not just the happy path
- ✓Has a named owner accountable for keeping it current
- ✓Can be read and applied by someone unfamiliar with the process
- ✓Versioned — changes tracked with date and reason
- ✓Reviewed at least quarterly or when the process changes
✗ Poor Process Documentation
- Describes the ideal process, not the real one
- Covers only the standard path — exceptions are “handled by the team”
- No named owner — maintained by nobody
- Requires prior experience to interpret correctly
- No version history — impossible to know if it’s current
- Last reviewed date is blank or more than 12 months ago
Documentation Audit
How to Assess Your Current Documentation Quality
Completeness
Trigger and scope clearly defined
All roles and their responsibilities documented
Process flow covers 100% of standard path
At least 3 exception scenarios documented
All systems and tools referenced by step
Currency & Governance
Named process owner listed with contact
Version number and last reviewed date visible
Reviewed within the last 6 months
Change log shows at least 1 update in past year
Stored in a location accessible to all who need it
Scoring
9–10 checks: documentation is fit for automation. 6–8: gaps exist but document is usable — fix before automating. Below 6: documentation needs significant work before it can support any automation initiative.
Process documentation example Employee Onboarding
Process Document · HR Operations
Employee Onboarding
Standard Operating Procedure — Full-Cycle New Hire Integration
Section 1
Process Header
Process ID
HR-OPS-001
Process Name
Employee Onboarding
Department
Human Resources
Category
HR Operations
Version
2.1
Effective Date
01 March 2025
Process Owner
Head of HR Operations
Approved By
Chief People Officer
Applicable Systems
HRIS, IT Provisioning Portal, Payroll System, LMS
Regulatory References
Labour Law Art. 14, Data Protection Act §8
Section 2
Trigger & Scope
Process Trigger
A signed employment contract is received and confirmed by HR. This event initiates onboarding and sets Day 1 as T+0 for all downstream tasks.
End Condition
The new hire completes mandatory training, all system access is granted, and the 30-day check-in is logged in the HRIS.
In Scope
- Full-time and part-time permanent employees
- Fixed-term contract employees (>3 months)
- Pre-boarding document collection
- IT equipment and system provisioning
- Mandatory compliance and safety training
- Payroll and benefits enrollment
- 30-day and 90-day check-ins
Out of Scope
- Contractors and freelancers (see HR-OPS-004)
- Interns (see HR-OPS-006)
- Internal transfers between departments
- Rehires within 6 months of departure
- Executive-level onboarding (bespoke process)
Section 3
Role Map
| Role | Responsibilities | Decision Authority |
|---|---|---|
| HR Coordinator | Initiates onboarding workflow, collects documents, schedules Day 1 orientation, logs milestones in HRIS | Can approve document extensions up to 5 business days |
| Hiring Manager | Confirms start date, assigns buddy, completes 30-day and 90-day check-in forms, approves role-specific training plan | Can approve role-specific access requests; cannot approve system-wide access |
| IT Administrator | Provisions hardware, creates system accounts, configures access permissions per role profile, delivers equipment on or before Day 1 | Approves or denies access requests based on role classification |
| Payroll & Benefits | Enrolls employee in payroll system, configures benefits package, confirms bank details, issues first-month payslip confirmation | Can approve benefits selections; salary changes require CPO sign-off |
| New Employee | Completes pre-boarding forms, attends orientation, completes mandatory training within 10 business days, signs required policies | N/A — no approval authority |
Section 4
Process Flow
1
Contract confirmation received
HR Coordinator · Trigger event
Signed contract is logged in HRIS. Start date is confirmed. Onboarding checklist is created and assigned. Pre-boarding email is sent to the new hire within 1 business day.
2
Pre-boarding document collection
HR Coordinator · T–10 to T–3
New hire completes pre-boarding portal: ID documents, bank details, emergency contacts, tax forms. HR validates completeness within 2 days of submission.
⚠ Decision: Documents complete? → If no, extend window max 5 days or escalate
3
IT provisioning request
HR Coordinator → IT Administrator · T–5
HR submits provisioning request via IT Portal with role profile. IT configures hardware, email, system accounts, and access permissions. Equipment must be ready by T–1.
4
Payroll & benefits enrollment
Payroll & Benefits · T–3
Employee is registered in payroll system. Benefits package is configured based on contract type and grade. Bank details are verified. Confirmation sent to employee by T–1.
5
Day 1 orientation
HR Coordinator + Hiring Manager · T+0
New hire attends welcome session, receives equipment, is introduced to team and buddy. Signs remaining policy documents. Office tour and safety briefing completed.
6
Mandatory training completion
New Employee + Hiring Manager · T+1 to T+10
Employee completes compliance, data protection, and safety training via LMS. Hiring manager approves role-specific training plan. Completion is logged automatically.
⚠ Decision: Training complete by T+10? → If no, escalate to HR and flag in HRIS
7
30-day check-in
Hiring Manager + HR Coordinator · T+30
Hiring manager completes structured check-in form in HRIS. HR reviews integration status. Any access gaps or training deficiencies are flagged for resolution. Process closed upon completion.
Section 5
Exception Handling
| Exception Scenario | Resolution Path | Owner | SLA |
|---|---|---|---|
| Documents not submitted by T–3 | HR sends reminder at T–5. If still missing at T–3, HR Coordinator escalates to Hiring Manager. Extension of up to 5 business days granted. Start date may be deferred if critical documents are absent. | HR Coordinator | Resolve within 5 days or defer start |
| IT equipment not ready on Day 1 | IT provides temporary loaner device. Full provisioning must be completed within 2 business days. IT Administrator logs incident and root cause in the IT Portal. | IT Administrator | Loaner same day; full kit within T+2 |
| Employee fails mandatory training by T+10 | HR flags in HRIS. Hiring Manager notified. Employee given 5-day extension. Continued failure triggers a formal performance note and CPO review. | Hiring Manager + HR | Extended deadline T+15; review T+20 |
| Offer rescinded before Day 1 | HR immediately cancels all provisioning requests, removes HRIS record, and notifies IT and Payroll. Legal reviews rescission basis. All pre-boarding data deleted per data policy. | HR Coordinator + Legal | Cancel all tasks within 4 hours |
| Employee no-show on Day 1 | HR contacts employee and Hiring Manager within 2 hours. If no response by EOD, HR escalates to CPO. IT access suspended (not deleted) pending clarification within 24 hours. | HR Coordinator | Escalate within 1 business day |
Section 6
Controls & Compliance
Document completeness check
HR Coordinator must validate all pre-boarding documents before onboarding proceeds past Step 2. Incomplete submissions are blocked in HRIS until resolved.
Mandatory gateIT access approval per role profile
System access is granted only per the approved role profile classification. Any access beyond the standard profile requires IT Administrator approval and Hiring Manager sign-off. Logged in IT Portal.
Access controlMandatory training sign-off
LMS auto-records training completion. Compliance training (data protection, health & safety) must be completed before the employee can access regulated systems. Non-completion is flagged to HR.
Regulatory · Data Protection Act §8Payroll enrollment confirmation
Payroll & Benefits must confirm successful enrollment before Day 1. Unconfirmed enrollments are escalated to the CPO. No employee may begin work without payroll confirmation on record.
Financial controlAudit trail — HRIS logging
All onboarding milestones, approvals, exceptions, and check-ins are logged in HRIS with timestamp and actor. Audit log is retained for 5 years per Labour Law Art. 14. Accessible to HR and Compliance.
Audit · Labour Law Art. 1430-day review gate
Onboarding is not marked complete in HRIS until the 30-day check-in form is submitted by the Hiring Manager and reviewed by HR. This is a hard close condition — no exceptions.
Mandatory gate