The Documentation That Matters

Workforce estates are documented extensively in project deliverables nobody reads and not at all in the four places it would help.

The chain diagram

One page: which system feeds which, by what mechanism, on what schedule, owned by whom.

Most organisations have never drawn it, and drawing it finds things — a join nobody knew about, and one everybody assumed was automated.

Kept current, which means updated when anything changes rather than annually.

The rule register

Every pay rule and the single system that applies it.

Versioned, so a question about a payment two years ago has an answer.

This is the document that prevents the classic defect and the one most worth an afternoon.

The manual step register

What, who, when, why, and what happens if it does not run.

Including the deputy, who is the actual control.

It is also the business case for integration work, because a list of twelve named dependencies is more persuasive than a budget request.

The interface specifications

Field by field, per join, with formats and the failure behaviour.

Frequently the vendor has one and nobody asked for it.

Where a join is custom, this is the only thing standing between you and reverse-engineering it later.

What not to write

A two-hundred-page implementation document describing a configuration that changed within a year.

Process narratives that duplicate what the systems do.

Anything that exists only to satisfy a project gate, which is most of what gets produced and none of what gets used.

Keeping them alive

Tie updates to the events that make them stale: an upgrade, a reconfiguration, a reorganisation, a new site or country.

Assign each document to the chain owner, because documents with no owner are historical records within a year.

And test them: can the deputy follow the chain diagram and the manual step register to run a period? That is the only measure of whether the documentation works.

Test it with the deputy

The only measure of whether documentation works.

Can the deputy follow the chain diagram and the manual step register to run a period, unaided?

Try it once, deliberately, while the owner watches rather than helps.

Whatever they had to ask is a gap, and it takes minutes to fill while it is fresh rather than months after a resignation.

Reproduce the workflow

For another way to make this requirement testable, consult this sector page. Reproduce the case with real roles, codes, failures and recovery steps.