For everyone · Free quote
System Documentation
Never be stuck when a developer leaves.
“Our developer left and nobody knows how the system works.”
If everything about your system lives in one person's head, you have a problem the day that person leaves. We write it down: what the system does, how to use it, how it's put together and how to fix the common problems. Every system we build comes with this. We also write it for systems someone else built.
- — How your system works, in plain language
- — Step-by-step guides for your staff
- — Technical notes for the next developer
What's included
An owner's guide
What the system does, what you pay for each month, and who to call for what.
Staff how-to guides
Short step-by-step instructions with screenshots for the tasks your team does every day.
Technical documentation
How the system is built, where everything lives and how to set it up, written for the next developer.
What to do when it breaks
The common problems and how to fix them, so a small issue doesn't stop the business.
Frequently asked
Can you document a system you didn't build?
Yes. We read the code, use the system and talk to the people who run it, then write down what's really there.
Who is the documentation for?
Three readers: you as the owner, your staff, and whichever developer works on it next. Each gets their own section.
Does it go out of date?
It can. On a care plan we update the documentation whenever the system changes.