What Documents Should an Industrial Software Vendor Deliver at Handover?

What happens when the system runs and the documents never arrive?

Handover meetings often treat documents as leftover paperwork. The system is live, operators have been walked through the screens, and the remaining files are promised for the following week. That week becomes a quarter. By then the project team has dispersed, and the only person who can explain a tag, a table or a screen mapping is no longer assigned to the site.

The damage from missing documents does not show up on the acceptance day. It shows up later, in situations every plant eventually meets. An industrial software project — SCADA, MES, energy management or a shop-floor integration — is maintainable only to the extent that its documents can be found and read.

• A PLC is replaced and a tag must be remapped, but nobody can find which I/O point or which register it occupied
• A production report must be changed, but nobody wrote down which database tables it reads or which aggregation rule it uses
• The original vendor engineer has left, and the plant cannot train a new operator from the materials it actually holds
• A second contractor is asked to extend the system, and has to reverse-engineer addresses, screens and interfaces before any new work can start
• A maintenance dispute arises, and there is no rolling checklist or annual report that shows what work was actually done

These five situations are the ordinary life of a plant system after go-live, not rare accidents. The fourteen documents exist so that a line change, a staff change, a later integration and a maintenance review stay routine instead of turning into archaeology.

Which fourteen documents belong in the handover package?

A complete industrial project document set runs to fourteen types: project proposal, technical agreement, specification, I/O allocation table, address allocation table, network topology diagram, screen design specification, operation manual, database table description, data interface specification, test report, acceptance materials, maintenance checklist, and annual maintenance report. Listing them as a flat pile does not help a buyer inspect a box of files. Grouping them by the question each group answers does.

The table below is written for the handover meeting. The third column is not a stage-exit condition; it is what to look at before signing the acceptance sheet.

Name this list in the technical agreement before work starts. A document that is not named at signing is a document that will be discussed after the project team has left, when reconstruction is slow and arguments are hard to settle.

What should the buyer check before signing the handover?

Signing the acceptance sheet closes the project for the vendor. For the plant it opens the period in which the documents have to stand on their own. The questions below can be asked in the handover meeting; if the answer to any of them is "we will send it later", that item has not yet been delivered.

• Is each of the fourteen types named in the technical agreement, or does the contract only say "documentation" without a list?
• For each named document, is this the as-built version that matches the installed I/O, addresses, screens and interfaces?
• Can a person who did not join the project follow the operation manual and complete a shift without calling the vendor?
• Does the test report state the criteria, the method, the result and the date, so a third person can tell pass from fail?
• Do the database table description and the data interface specification name tables, fields, directions and the owner of master data?
• Are the maintenance checklist and the annual maintenance report already in a usable template, so the next year's work has a baseline?
• Who holds the editable source files after handover — the plant, or only a PDF the vendor retains?

The last question is the one most often skipped. A signed PDF is a record. An editable I/O table, address table and network diagram are the tools the plant needs when the line changes. Record and tool are both required; one does not replace the other.

In which language and in which format should the documents be delivered?

A document the operators cannot read will not be used after go-live. Language is a handover condition, not a translation task to be finished later, and it should be written next to each document name in the technical agreement.

Format decides whether a document can still be used. A scan of a marked-up drawing is a record. An editable I/O allocation table, address allocation table and network topology diagram are working tools. Both are needed.

• Working language of meetings and of the standing contact — for an English-speaking plant, an English-speaking contact who stays through the project, not an interpreter who joins once
• Language of the specification and of the operation manual — English for the operators and maintenance staff who will use them; a file whose cover is translated and whose body is not does not count as delivered
• File format — editable source (spreadsheet, drawing, document) plus a signed PDF record; state which documents must be supplied in both forms
• Revision control — each document carries a version, a date, and a mark that distinguishes the design issue from the as-built issue

Write language and format into the same table as the document names. A vendor that can fill that table before signing already treats documents as deliverables rather than as files to be collected at the end.