Requirements, Specification and Project Stages

The functional specification, the I/O list, project stages and effort, change control, FAT and SAT, and what makes projects late.

Writing the specification

Start with what the machine must do, in words the customer, the electrical designer and the programmer all understand. Two documents are usually involved: the user requirements (what the customer needs: output, quality, operating modes, environment, standards) and the functional description (how the system will do it: the sequence, the interlocks, the faults and the displays). The second is checked against the first.

SectionWhat it contains
Purpose and scopeWhat the machine does and what is outside the job (who supplies the conveyor, the air, the network)
Process and throughputProduct, cycle time, rate, batch size, changeover, the sequence of steps
Operating modesAutomatic, manual, set-up, maintenance, and how the machine moves between them
Faults and recoveryWhat must be detected, what the machine does, what the operator does; what happens after a power loss
InterfacesTo the line, the plant network, the MES, other machines, operators and maintenance staff
Environment and standardsTemperature, dust, washdown, altitude, voltages, the standards, markings and certificates required
SafetyThe risk assessment and the protective measures chosen (see Machine Safety Systems)
Documentation and trainingWhat is delivered at handover (see Documentation, Handover and Lifecycle)
Acceptance criteriaExactly how each requirement will be shown to be met

Worked example: a requirement that can be tested

  • Poor: “The machine shall be fast and reliable.” There is no way to say whether it is.
  • Good: “At least 45 parts per minute, with a stop rate below 2 per hour over a 4-hour run, measured at the SAT.” It has a number, a condition and a place where it is measured.
  • In a specification of 42 requirements, a review finds 6 that cannot be tested as written (14 %). Each one is a future argument at acceptance: rewrite it now, with a number and a test.
  • Write each requirement as a sentence with “shall”, give it a number, and link it to the test that shows it is met: a traceability table is the best tool against a disputed acceptance.

The I/O list and counting

Then list every signal. The I/O list drives the controller and card selection, the panel size, the cable count, the programming and the testing, and it must match the schematics, the program and the HMI tag for tag.

TagDescriptionTypeSignalRange / notes
PB_StartStart buttonDigital input24 V DCNO contact, panel door
PB_EStop_OKE-stop healthy feedbackDigital input24 V DCFrom the safety relay, not a safety function
PT_101Line pressureAnalog input4–20 mA0–10 bar, loop powered
TT_201Oven temperatureAnalog inputPt100, 3-wire0–200 °C
M_301_RunConveyor motor startDigital output24 V DCTo the VFD run input
XV_401Pneumatic valveDigital output24 V DC1.5 W solenoid

Worked example: counting and costing the I/O

Signal typeNeededWith 20 % spareCard sizeCardsSpare points
Digital inputs (24 V DC)647716 per card5 cards16 spare
Digital outputs (24 V DC)404816 per card3 cards8 spare
Analog inputs (4–20 mA)16198 per card3 cards8 spare
Analog outputs (4–20 mA)454 per card2 cards4 spare
RTD (Pt100) inputs8104 per card3 cards4 spare
  • 132 points across 16 cards. Rounding up to whole cards usually gives more than the 20 % spare asked for: check each row.
  • Effort. At about 7 hours per point for design, wiring, programming and testing (a typical figure; use your own history), plus 160 hours of fixed work (specification, project management, documentation): 132 × 7 + 160 = 1 084 hours, or $92 140 at $85 an hour.
  • Name signals consistently (ISA-style tags such as PT-101, or the project’s own convention) and use the same name in the schematic, the I/O list, the PLC program and the HMI.
  • Agree responsibilities in writing: who supplies the field devices, who wires them, who writes the program and who owns the network and the safety design.

Stages and effort

Specifyrequirements,risk assessment,I/O listDesignschematics,network,panel layoutBuildpanel wiring,programmingFATtest at thefactory beforeshippingInstallwiring, SAT,commissioningHandoverdocuments,training,backupsFinding a fault at FAT is cheap; finding it on site, with the line stopped, is not.
The usual stages of an automation project. The factory acceptance test (FAT) catches problems before the equipment ships.
StageMain outputs
SpecifyFunctional description, throughput and cycle time, environment, standards, risk assessment, I/O list, budget and schedule
DesignElectrical schematics, panel layout, network and architecture drawings, bill of materials, software structure
BuildPanel assembly and wiring, programming of the PLC, HMI and drives, simulation and testing in the workshop
FATFactory acceptance test: demonstrate every function against the specification, with the customer if required
Install and commissionMechanical and electrical installation, I/O checks, loop checks, site acceptance test (SAT), tuning
HandoverAs-built drawings, program backups, manuals, spare parts list, operator and maintenance training

Worked example: spreading 1 084 hours

StageShare (typical)Hours
Specify10 %108 h
Design (schematics, layout)20 %217 h
Panel build and wiring15 %163 h
Software (PLC, HMI, drives)25 %271 h
FAT5 %54 h
Install and commission20 %217 h
Handover and training5 %54 h

Software and commissioning together take about half the effort. The early stages are cheap but decide the rest: 30 % of the hours go into specifying and designing, and the cost of a mistake found later grows steeply (see the figure below).

Where the hours go, and what a late change costsSpecify100 hDesign (schematics, layout)200 hPanel build and wiring150 hSoftware (PLC, HMI, drives)250 hFAT50 hInstall and commission200 hHandover and training50 hHours for a 1 000 hour projectSpecification1 xDesign3 xBuild8 xFAT20 xCommissioning50 xRelative cost of fixing one mistake (typical shape)
Hours by stage for a 1 000 hour project, and the typical cost of fixing the same mistake at each stage.

The schedule and the critical path

A schedule is the tasks, their durations and what each depends on. The critical path is the chain of tasks with no slack: a day lost on it is a day lost on the project. Everything else has float.

Worked example: an eight-task project

TaskDurationEarliest startEarliest finishFloat
A Specification and risk assessment10 d0100 dcritical
B Electrical and layout design20 d10300 dcritical
C Order long-lead parts (drives, enclosure)30 d30600 dcritical
D Panel build and wiring15 d60750 dcritical
E PLC, HMI and drive programming25 d305520 d
F FAT5 d75800 dcritical
G Ship and install10 d80900 dcritical
H Commission and SAT10 d901000 dcritical
  • The project takes 100 days. The critical path is A → B → C → D → F → G → H: the long-lead order and the panel build, not the software.
  • The software (E) has 20 days of float: it can slip that long without moving the end date, but a late start squeezes the FAT.
  • Shortening the project means shortening the critical path: ordering the long-lead items earlier, buying a drive from stock, or building the panel in parallel with a second crew. Speeding up the software would change nothing.
  • Re-check the path as the project moves: a delay on a non-critical task can use up its float and make it critical.

Change control

Changes are normal; uncontrolled changes are the problem. Agree a procedure at the start: every change is written down, its effect on cost, time and safety is assessed, and it is approved by the customer and the project manager before work starts.

Worked example: the cost of a late change

Adding a sensor and its wiring costs $400 if it is in the specification. Found at the design stage it costs about 3 times as much; at the FAT 20 times; at commissioning 50 times: $20 000 instead of $400 (the multipliers are a typical shape, not a law: panels get re-opened, drawings re-issued and tests repeated). This is the best argument for spending time on the specification and the review.

  • Freeze the I/O list and the architecture at a named date, and treat later changes as variations.
  • Review the design with the people who will test, install and maintain it: they find problems the designers cannot see.
  • Record decisions and their reasons (a short log); it settles arguments months later.

FAT, SAT and the acceptance criteria

TestWherePurpose
FAT (factory acceptance test)The supplier’s workshopShow that the equipment meets the specification before it ships, with simulated or real inputs and outputs, so that faults are fixed where tools and staff are at hand
SAT (site acceptance test)The customer’s siteRepeat the important checks with the real wiring, utilities, product and operators
Run-in or trialOn siteRun for an agreed time or number of cycles to prove the rate, quality and reliability

The criteria must be agreed before the build; the details of the tests are in Testing, Commissioning and Acceptance. Link payment to them.

Worked example: payment milestones

MilestoneShare of the price
Order placed30 %
Design approved20 %
FAT passed30 %
SAT passed15 %
End of warranty period5 %
Total100 %

Holding back 20 % until the SAT and the end of the warranty gives the supplier a reason to finish properly, and the customer a way to have defects fixed. Tie each payment to an event that can be shown, not to a date.

Responsibilities, contracts and risks

QuestionWho should answer it, in writing
Who supplies and installs the field devices, cables, air, power and network?Customer and integrator, split by item
Who writes and owns the PLC, HMI and drive programs and the source files?Agreed in the contract (the customer usually needs the source and the passwords)
Who carries out and signs the risk assessment, and who validates the safety functions?The machine builder (see Machine Safety Systems)
Who is responsible for the network design, the IP addresses and the connection to the plant network?Customer IT or controls, with the integrator (see Industrial Communication)
What is the warranty, the support period and the response time?The contract

Worked example: a simple risk register

RiskProbabilityDelay if it happens (days)Expected delay (days)
Late delivery of the drives40 %124.8
Scope change by the customer50 %157.5
Site not ready for installation30 %103.0
Key engineer unavailable20 %204.0
Total expected19.3 days

On the 100-day schedule that is 19 %, so a contingency of 10 to 20 % is not padding but arithmetic. Put it at the end, name its owner, and use it deliberately.

What makes projects late

CausePrevention
A vague or untestable specificationNumbers and tests for every requirement
I/O and architecture changing lateFreeze dates and change control
Long-lead parts ordered lateOrder drives, enclosures and special devices at design approval (see the critical path)
Customer-supplied items late or wrongList them, with dates and responsibilities
Software left until the panel is builtProgram and simulate in parallel; test against a simulator at the FAT
Site not ready (no power, no air, no floor)A site checklist signed before shipping
Safety discovered at the endRisk assessment at the start (see Machine Safety Systems)
No time for documentation and trainingPlan them as tasks with owners (see Documentation, Handover and Lifecycle)

Related

FAQ

How much spare I/O should I plan for?

About 15 to 20 % spare points, plus spare panel space, power supply capacity and wire duct. Round up to whole cards and check the result per type.

What goes into a functional description?

The sequence, the operating modes, the interlocks, every fault and its response, the interfaces and the displays, written so that the customer and the programmer both agree on what the machine will do.

Why test at the factory as well as on site?

Faults are cheaper to fix at the factory, where tools, spares and staff are at hand and the line is not stopped. The SAT then only has to prove what depends on the site.

Who owns the PLC program?

It should be written into the contract. The customer normally needs the source files, the passwords and the right to modify them for maintenance.

References

  • ISO/IEC/IEEE 29148, Requirements engineering; IEC 61131-3 (programming) and IEC 61512/ISA-88 (batch and recipe terminology).
  • PMI, A Guide to the Project Management Body of Knowledge (critical path, risk and change control).
  • IEC 60204-1 and ISO 12100 for the electrical and safety requirements that the specification must cite.

Last reviewed: October 2026. Hours, rates and delays are typical and illustrative: use your own history.