
Ownership & operations
Make the work understandable to someone else
Preserve the reasoning that code and screens cannot explain. A useful handover prevents the next person from having to rediscover important constraints.
Pattern Engine · Practical field notes
The most valuable documentation often explains why an apparently sensible change would be wrong. A filter may exclude incomplete jobs because another system treats every received record as ready for dispatch. Without that context, the next maintainer may “fix” the filter and break the operation.
A useful handover transfers the reasoning a person cannot recover from the interface alone. Its success is visible when someone else can operate, change or recover the system without guessing what the original builder intended.
Preserve what would be costly to rediscover
Platform manuals can explain how a setting works. They cannot explain why your business chose it, which customer promise depends on it or which alternative already failed a useful test. Those are the details worth preserving locally.
Separate reference facts from instructions and explanations. Someone responding to an incident needs a short route to the relevant action; someone changing a rule needs the context behind it. Diátaxis offers a useful framework for distinguishing those needs without forcing everything into one long document.
AI can draft a description of what code appears to do. It cannot reliably reconstruct an unstated business reason from the code. Capture that reason while the decision is being made, then verify generated instructions through actual use. The scarce resource in a handover is often context, not prose.
Include what the interface cannot explain
Screens can show how a feature works, but they rarely explain why a particular rule exists or which other system depends on it. Document important assumptions, constraints and deliberate omissions.
For example, a nightly import may intentionally exclude incomplete records because the receiving system treats them as ready for dispatch. Without that explanation, a future maintainer might “fix” the filter and create an operational problem.
Keep credentials out of the documentation itself. Record where authorized people obtain them and who can grant access. Include the accounts, domains, repositories and subscriptions the business must retain control of.
Use a handover exercise
Ask someone who did not build the system to perform a representative task using the documentation. Have the builder observe without immediately supplying missing steps.
Useful exercises include adding a user, correcting a failed record, making a small change in a test environment and locating the recovery procedure. Choose tasks that match the recipient’s actual responsibility rather than expecting a business owner to become a developer.
Every question reveals a possible gap. Update the instructions while the context is fresh, then repeat the part that failed. This produces more useful evidence than checking that a document was delivered.
Keep it small enough to maintain
Avoid duplicating a platform’s entire manual. Link to the relevant official guidance and document the decisions specific to your system. Screenshots are helpful when they clarify a step, but a heavily illustrated guide can become expensive to update after every interface change.
Give important documents an owner and revise them when the corresponding workflow changes. If a release changes permissions or recovery behavior, its documentation is part of that release.
A practical handover should leave the business with working access, understandable instructions and a known route to further help. Practical ownership covers the responsibilities around those assets; vendor exit applies the same thinking when the relationship or platform changes.
Document work for people and agents
AI coding tools benefit from concise project instructions: how to run checks, which decisions must be preserved and where the architecture is explained. Keep these beside the code and review them when the project changes. They help a new engineer as well as an agent find the right starting point.
The Agent Skills standard describes a portable way to package recurring procedures. Claude Code’s skills documentation shows one implementation, including supporting files and invocation controls. Treat generated documentation as a draft until someone has used it successfully.