How to write a specification before hiring an engineer
If you ask for three quotes with an idea described in two paragraphs, you will get three quotes for three different products. Each engineer will fill the gaps with their own assumptions, and there will be no way to compare them. The specification is what makes quotes comparable and what lets you tell, at the end, whether what was delivered meets the brief. It does not need to run to a hundred pages, but a few things do need to be written down well.
What a specification is (and is not)
The V-Modell XT, the German federal administration's reference model for developing systems, calls this document the customer's requirements specification. It defines it like this:
- It sets out all the binding requirements the customer places on the product, functional and non-functional.
- It is the basis for the quote and the contract.
- It also covers the phases of the product's life that have to be supported, the delivery conditions and the acceptance criteria.
- Its quality is the customer's responsibility.
- As a rule, it should not impose technical solutions, so as not to constrain whoever does the design.
In other words, the specification says what the product has to do. The how (the architecture, the components and the design) is proposed by the engineer in their quote and their design, with traceability between the two documents.
If you have real constraints, such as an enclosure already in production, a platform already chosen or a mandatory connector, write them down separately, as constraints and with the reason for each. That way the designer knows what is fixed and what is open to proposals.
It is the first of the phases of product development: the reference against which everything else will be tested.
How to write a requirement
NASA's systems engineering handbook has an appendix on how to write a good requirement. For a small product, its basic rules are enough:
- "Shall" for requirements, "should" for goals. "The unit shall operate between −10 and 50 °C" is a requirement. "The unit should weigh less than 200 g" is a goal. Separating them tells the engineer where there is room to negotiate.
- Values with tolerances. Not "one week of battery life", but "at least 7 days of battery life with one measurement every 15 minutes".
- One idea per requirement, numbered. That way it can be referred to in the quote, the test plan and the acceptance record.
- What, not how. If you write "shall use microcontroller X", ask yourself why you need it. The answer is usually the real requirement.
- With its rationale and assumptions. One line explaining where the value comes from.
- Verifiable. Every requirement must be checkable by test, demonstration, inspection or analysis.
NASA also gives a list of words that cannot be verified and are best avoided: easy, sufficient, adequate, fast, small, lightweight, robust, user-friendly, "when required"... Every time one appears, replace it with a number or a condition.
Two questions help to clean up the list. "What is the worst that could happen if this requirement were not included?" separates needs from wants. "And if the tolerance were doubled?" catches tolerances that make the product more expensive for no reason.
What you do not know yet
It is normal not to have everything clear at the start. NASA suggests a useful distinction:
- To be determined: the value is not known. Keep these to a minimum.
- To be resolved: it is better to give an estimate and mark it this way, stating what needs to be done to close it, who will do it and by when.
"Battery life: 7 days (to be resolved with the January pilot)" makes it possible to quote. "Battery life: to be determined" forces the engineer to guess. Keep a list of everything still open at the end of the document.
A minimum template
Combining the areas NASA recommends not to overlook with what we have covered in earlier articles, this is a minimum template for an electronic product:
- Purpose and users. What problem it solves, who uses it and where.
- Functions. What it has to do, as numbered requirements.
- Performance. Accuracy, response times, communication range, battery life, always with tolerances.
- Interfaces. With the user (display, buttons, indicators), with other equipment (connectors, protocols) and with the cloud or an app, if there is one.
- Power. Mains, battery or both, and how it is charged.
- Environment. Temperature, humidity, dust and water, vibration, not only in use but also in transport and storage.
- Markets and regulations. Where it will be sold, because that decides the certifications. If it is connected, it falls under the Cyber Resilience Act. If it has a medical purpose, it may be a medical device.
- Volume and target cost. How many units a year and at what manufacturing cost. Together with functions, environment and standards, it is among the first things we put in writing with every customer.
- Constraints. What has already been decided, with the reason.
- Acceptance and delivery. Which tests the prototype has to pass to be accepted, and what is delivered: schematics, manufacturing files, firmware, documentation.
- Open items. The list of points to be determined and to be resolved.
If the acceptance criteria in point 10 are written down from the start, the validation tests are designed against them and delivery does not depend on interpretation.
With the specification in hand
A specification like this lets you ask for a proposal with scope, timeline and price in writing. In the way we work, when the scope is clear the price is fixed, and when it is not we give an estimate with a cap. A good specification is what makes a fixed price possible.
If you already have a specification, we review it with you and point out gaps or conflicts before designing. If you only have an idea, we help you turn it into a specification as the first step of hardware design.
From requirement to design:Hardware designEmbedded firmware
Sources
- ITZBund, V-Modell XT Bund, version 2.3: requirements specification (Lastenheft), section C.1.10.1 (German).
- NASA, Systems Engineering Handbook, SP-2016-6105 Rev2: Appendix C, How to Write a Good Requirement.