Documentation for logistics software and processes
Procedures, guides and runbooks written from the work as it is done on your floor, tested with the people who will use them, and kept current after go-live.
Scope a project
Documentation is part of the system. If the night-shift receiver cannot find what to do when a truck arrives without a ship notice, the software does not work at 2 a.m., whatever the code does. We write documentation as a named deliverable in the statement of work, from the floor rather than from the specification, and we test it with the people who will use it.
What we write
| Document | Written for | What it covers |
|---|---|---|
| Standard operating procedures (SOPs) | Supervisors and leads | Each process step: who does it, the system steps, the exceptions and the checks a supervisor makes |
| User guides by role | Receivers, put-away drivers, pickers, inventory controllers, customer service, buyers | Only that role’s tasks, in the order they happen on a shift |
| Administrator guide | System administrators | Users and permissions, settings, master data upkeep, label templates, devices, and how to change each safely |
| Integration runbook | IT and support staff | Each interface: what it does, its schedule, how to check its health, common failures, how to replay a message, and who to call at each partner |
| Quick reference cards | People at a station | One page at the dock door, pack station or count cart: the scans in order and what each error message means |
Written from the floor
We write while watching the work, using your screens, your scanners and your labels, with screenshots and photos from your own environment rather than a vendor’s demo data. Each procedure starts from a trigger a person would recognize, such as “A truck arrives without a ship notice” or “The bin is empty but the system says 40”, and ends with the system in a known state.
We use the words your people use. If the floor calls a pallet ID a “license plate”, the guide says license plate and gives the system’s term in brackets. Steps are short and numbered, one action per step, with the screen or scan that confirms it worked.
Tested with users
A document is not finished until someone from the role has used it to do the task without help. We watch, note where they hesitate or go wrong, and fix the document rather than coach the person. The pass test is simple: a person new to the task completes it with the document alone.
Example (fictional). The first draft of a receiving card for dock 4 at a fictional distributor has six steps. In testing, the receiver skips “scan the pallet SSCC” because the label is on the side of the pallet facing the trailer wall. The card gains a step, “Turn the pallet or walk to the labeled side before scanning”, and a photo of where the label usually sits. The next receiver completes three test receipts for item EX-20118 without asking for help.
Kept current
Documentation goes stale the first time a setting changes. Each document has an owner on your side, a version number, a review date and a change log. Documents live wherever your team already keeps procedures, and you receive editable source files, not just PDFs.
Changes are tied to releases. A change request is not closed until the documents it affects are updated, and printed reference cards carry their version and date so that an old card at a station is easy to spot. A document register lists every document, its owner and its next review.
For systems you already own
Many teams run a WMS or ERP that went live without usable documentation, or with guides that describe the vendor’s defaults rather than your configuration. The Documentation and onboarding engagement, described on our engagements page, covers exactly that. We walk the process, document the system as it is configured and used today, and can train your people on it through onboarding and training. No build is needed, and it is often a sensible first piece of work with a new team.
The same applies to interfaces. If your EDI or API integrations run but nobody has written down how, we inventory them and write the runbook, using the same structure as our integration work.
What you receive
- SOPs for each process in scope.
- A user guide for each role.
- An administrator guide and an integration runbook.
- Quick reference cards for each station, ready to print.
- A document register with owners and review dates.
- Editable source files for everything above.
What we need from you
- Access to the floor during normal shifts, including a night or weekend shift if the work differs.
- A person from each role for a short test session per document.
- An owner on your side for each document after handover.
- Your existing procedures, even if they are out of date. They show what people were told, which helps explain what they actually do. Before go-live, the go-live readiness checklist confirms each document is approved and in place.
Scope your project.
Tell us what you need to track, which systems you run and when it has to work. We reply with questions or a time to talk.