Online articles, commentaries, papers
Navigation links at the bottom of the page

Writing Specifications

Specifications serve three purposes. They:
  1. make sure the client gets the product or service required;
  2. are a means of equating expenditure with a budget; and
  3. specify to the contracting party precisely what is wanted.
All other objectives are subordinate to these three. Because they are the basis of all engineering and scientific contracts, technical specifications must be written with care. Conversely, badly-written specifications cost time, money and effort.
This article deals with specifications in all their aspects and explains their purpose, content, development and types. For brevity, whenever the word 'specification' or its plural form is used, the meaning 'technical specification' is intended.
The preparation of specifications is the first and most important step in any contract negotiation. Without them, cost studies, estimates, schedules and contract responsibilities are difficult to define. Well-written specifications must:
  • Avoid contractual commercial difficulties
  • Meet performance objectives
  • Avoid maintenance problems
  • Meet budget objectives
GENERAL
A specification is a detailed description of the particulars of some projected work in any scientific, manufacturing process or engineering discipline by stating the dimensions, material content, quantities, and performance of the work. The technical specifications also give the directions to be followed by the designer, builder or constructor. A specification defines the items that are to be produced, services provided, and the performance required of them.
They do not specify how the work is to be done; this is the purpose of procedures (see HOW TO WRITE PROCEDURES). Well-written specifications may make reference to the procedures necessary when certain processes are to be followed. When specifications refer to 'items' they include not only the hardware including machinery, buildings, and installations, but the software as well. Software includes documents, computer programmes and, often, the item design calculations.
In view of the North American Free Trade Agreement (NAFTA) and resulting increased cross-border commerce, a last general observation regarding the preparation of specifications is well worth making. This is that although the phrase 'or equal' is commonly included in specifications, those who prepare specifications in the U.S.A. can include or omit the phrase as they wish. Whatever they decide, U.S. law is on their side.
In a 1974 decision* (see the end note), the U.S. Supreme Court upheld the right of those who write specifications to choose those invited to bid as they wished. The ruling was an important one. It has implications for Canadian contractors and owners doing business across the U.S.-Canada border. The Supreme Court handed down four principal rulings:
  • Proprietary specifications do not violate anti-trust laws. Professionals who write specifications judge what products will best suit the needs of their clients. Technically, no two products are identical and if the specifier wants to limit the specification to one source, he has the right to do so and to enforce it.
  • Other manufacturers or suppliers can qualify as OR EQUAL only when the specifier chooses. The specifier, however, is responsible for judging if a proposed substitution is an acceptable OR EQUAL product. Furthermore, if the specification does not include an OR EQUAL provision, it is still the specifier's decision as to what products do or do not qualify as OR EQUAL.
  • The Court stated that the specifier" ... may waive specifications in order to obtain a more desirable product for the client." The implication of this is that, ultimately, only the specifier can decide if an OR EQUAL product is an acceptable substitute to the product specified and in the best interest of the client.
  • In conclusion, the Court stated, "The burden is on the supplier or manufacturer who has not been specified to convince the specifier that their product is equal for the purpose of a particular project."
PURPOSE
To some degree, the purpose of specifications was discussed in the introduction. A technical specification must provide the contracting parties with clear knowledge of the expectations of both the end user and the supplier. A graphic example of a badly-written specification occurred in the heyday of travel by rail.
A British railway company wrote a specification for drinking glasses for use in its dining cars. The law required that beer be served in glasses that would hold half a pint. The successful supplier was able to put in a bid ten per cent lower than competitors when it read the specification. The glass thickness, top and bottom diameters of the glass, and the glass height were specified. By producing a glass with curved, not straight, sides, the supplier was able to reduce the material needed by ten per cent. The glass met the specification but did not hold half a pint. The specification writer had omitted to specify the volume requirement.
Bearing this example in mind, specification writers should have a good knowledge and understanding of five things:
  1. The function, use and purpose of the service required; its output and capacity.
  2. How and by what means the item or service can be produced.
  3. How to specify requirements in logical order.
  4. How to write the specification in concise and unambiguous language.

Additional time spent in writing, reviewing and approving the specification reduces the chances of additional costs and equally costly delay of completion.

TYPES OF SPECIFICATIONS
Specifications may be grouped in one or more categories and can exist under different names. For example, design requirements themselves can be specified for the direction of system and equipment designers. These are used by designers to evolve a given equipment or system design. As such, design specifications do not necessarily result in the production of hardware. Here is an explanation of the various groups of specification types to be found in industry.

1. CONCEPT SPECIFICATIONS
These are written in general terms to define a product or major undertaking. They serve as a foundation for conducting an investigation, feasibility study, and the probable life cycle cost of an undertaking.
For example, this type of specification might apply to a manufacturing plant required to begin production of a commodity at a given time. The concept specification might, and often does, state transportation needs, lines of communication, market requirements, raw material markets, security, waste disposal criteria, and required soil conditions.

2. DESIGN
Design specifications are used to define system or equipment performance, output capacity, and the range of design licence open to the designer. For example, a designer may be restricted to the use of electrical or hydraulic means for a power-operated mechanism. This rules out the use of, for instance, pneumatic means. Similarly, an architect may be limited to concrete in the use of materials in a building design.
The design specification writer must know what design restrictions apply before writing the document. The actual structure of form of specifications will be dealt with later in the chapter.

3. DESIGN DESCRIPTION
Design description specifications are normally those produced by the designer. They are not the same as design specifications (see the preceding item), which govern the designer's work. The design description defines and specifies a design solution that meets the design specification. Specifications in this category serve two purposes.

  • They are submitted to the organization issuing the design specification as evidence that the specification has been met.
  • They are used by other designers to produce equipment specifications, construction and manufacturing drawings.

4. CONSTRUCTION AND MANUFACTURING
Specifications in this category consist of drawings and written details that cover the product, system, building, or service. They include references to regulatory controls, acceptable national, international and industry standards; specify criteria that must be met by contractors or suppliers who wish to submit bids; and limit products and services bidders may or may not include in their bids and proposals.

5. PROCESS
Process specifications describe the technical processes that will be used in the manufacture of a product, or construction of a building or system. These processes include the heat treatment of foundry castings, rules for pre-stressing concrete beams, bolt torques on bridge anchors, seismic measurements, and specific chemical processes to name a few.
In many ways, process specifications are specified procedures and are often regarded as procedures as opposed to specifications. For example, the American Society of Mechanical Engineers (ASME) Boiler and Pressure Vessel Code contains specifications that include process procedures.

6. STANDARDS
The use of standards has already been mentioned in conjunction with construction and manufacturing specifications. Nevertheless, standards are specifications in a category of their own. They are written by national and international bodies (the ASME Boiler and Pressure Vessel Code is used internationally), by industries, and even by large corporations.
There are many examples of standards as specifications. The U.S. Military Specifications, the Canadian Federal Department of Works Master Construction Specification, and Ontario Power's extensive welding standards fall into this category. Standards, however, can be one of three types:
  • To provide specific requirements for products such as material, fasteners and fittings that, among various suppliers, are interchangeable.
  • Specify product material requirements as in the first type, but suppliers are permitted some latitude to meet the standards. In this case, however, the products from different suppliers are not interchangeable.
  • To cover processes and practices not specific to a product or item. Standards of this type can be recognized in titles such as Codes of Practice, General Requirements, Guide, Test Methods, and Quality Assurance.
Specification writers need to be familiar with each type of standard to avoid the mistake of unnecessarily restricting the sources of supply. A too rigid specification can limit competition and lead to over-priced goods and services. In summary, the first type is rigid in its definition; the second allows greater flexibility of supply; and the third is more general in nature, allowing for various configurations in which goods and services can be supplied.
Here are some points worth remembering in the use and application of standards.
  • Goods produced to standards are usually reliable, economically manufactured, and available from several suppliers.
  • Regulations and sales volumes influence the choice of standards and their use.
  • The use of standards tends to inhibit progress because they are frequently revised and re-issued. Agreement nationally and internationally takes time. Revised standards lag behind the technology they govern.
  • The imposition of standards can be costly. The introduction of metrication to replace Imperial standards is a good example.

In retrospect, the use of standards is beneficial and their use also helps reduce the size of originally-written specifications.

ANATOMY OF A SPECIFICATION
What should a specification include? Its content will vary according to its type, purpose and application. The subject is so large that it is not practical to give an example of each category explained because to do so would take excessive space. A general listing of the content will serve as a checklist for those who need to write a specification as part of their work.

1. IDENTITY
Assign a number to identify the specification for use in the commercial contract, or other specifications.

2. REVISION REFERENCE
Specifications are often revised. Provide a reference for each revision issued. Use a letter or number designation and date it so that the user is aware of the version that applies.

3. TITLE
Provide a concise and distinctive title. Avoid using long titles; they are confusing.

4. INTRODUCTION
Say what the specification is about. This can include the scope of the specification, its type, form, purpose and application.

5. DESCRIPTION
Describe the product or service covered: dimensions; materials; tolerances; finish; required spares.

6. PERFORMANCE
Describe the performance criteria, operating conditions, expected service, life expectancy, and service factors. Other performance requirements depend on the product, structure, or service.

  • For electrical, mechanical, hydraulic, aeronautical, and computer equipment, bio-medical, and chemical processing devices, performance will include power, speed, movement, pressures, operating temperatures, primary and stand-by power sources, and ratings.
  • For engineering and building structures, performance will include floor loadings, finish, materials.
  • Service factors for all products, structure or services could include environmental conditions: chemicals, temperature ranges, vibration, humidity, and dirt.

7. CONSTRUCTION
Construction, also meaning manufacture, should include reference to processes, chemicals, solvents, product handling, and the use of special tools and devices.

8. RELIABILITY
The specification should include information on service and maintenance factors that affect reliability. It should state limits on down-time to effect repairs, the availability of specialists for servicing, and replacement parts.

9. QUALITY ASSURANCE
The purpose of imposing quality assurance standards, as opposed to standards in general, is to provide an organizing framework within which the contract is carried out. The specifications define the quality of the service. Inspection and test requirements, forming part of the quality assurance programme, do not improve the quality of product or service, but provide objective evidence of the quality of goods or services provided.
The choice of what level of QA programme to specify is an economic one. Such programmes are expensive to develop and apply. The more detailed the programme, the greater the assurance that the service provided is of the required quality. The cost of the programme specified however must be assessed against the consequences of defective goods and services supplied to a less intensive programme. Increased costs stem from the rejection of parts during construction or their re-work.

10. PACKAGING AND STORAGE
The specification should describe the packaging, handling, shipping and storage requirements of the product.

11. STANDARDS AND SPECIFICATIONS
Throughout the specification other specifications and standards will be referenced. A separate listing of all specifications and standards cited should be summarized in this section.

12. RECORDS
The retention of accounting records is required by law. The retention of manufacturing, inspection and performance test records is what any manufacturing or service contractor observes for self-protection. Clients who issue specifications frequently have to meet national and industry regulatory controls by maintaining manufacturing as well as operating records.
Equipment manufacturing and maintenance records, sometimes referred to as history dockets, are essential when something goes wrong. They are equally essential for maintenance supervisors and operators who were not present when the equipment was received and commissioned.
For these reasons, specifications should include:
  • Direction to the contractor of exactly what construction records are needed and what drawings, spare parts information, operating manuals, installation information, and performance test records are required.
  • Direction to the contractor of what records are to be kept by the contractor and for how long.
SPECIFICATION WRITING
The objectives for which specifications are written were dealt with in the introduction to this session. Specification writing as used here includes the text, drawings, illustrations and sketches.
The basis for development of a specification is the same as that described for writing a technical report or procedure. To reiterate the advice given throughout these articles, the steps are:

Plan; research; outline; write; edit; review; and obtain approval.

It is not necessary to dwell on each of these steps in detail. Advice, however, that applies in particular to specifications is:
  1. Be positive. Omit statements that indicate lack of knowledge or uncertainty.
  2. Exclude requirements that cannot be enforced.
  3. Give direction, not suggestions.
  4. Give specific numerical data: values, maximum and minimum tolerances.
  5. Don't be vague with the use of such phrases as 'Good workmanship', 'easily cleaned', 'readily accessible' .
  6. Specify the contractor's responsibilities to subcontractors and third parties.
  7. Check and re-check alpha-numeric references to specifications and standards quoted.
  8. Be realistic and do not specify the unattainable.
  9. Write in the imperative style: 'Conduct the following tests ... etc.' in preference to the passive 'The following tests shall be conducted ... etc.'
  10. Be precise in the use of language and avoid:
  • Vague adjectives: good, fine, smooth, rough, high, low, large, small.
  • Adjectival strings: 'main circuit control switch', which could mean 'Control switch in the main circuit'; 'Main switch in the control circuit'; or 'A switch in the main control circuit.'

REVIEW AND APPROVAL
Anyone who reviews a specification should do so from the viewpoint of the contractor. Here is a checklist for anyone who has to review and approve a specification.

  1. Is it grammatically correct?
  2. Are any necessary requirements omitted?
  3. Are any unnecessary requirements included?
  4. Is the specification concise and unambiguous?
  5. Is it clear as to the what, when, where, how and why?

* George R. Whitten, Jr.,Inc,. d/b/a Whitten Corporation, Plaintiff-Appellant v Paddock Pool Builders, Inc., et al., Defendants-Appellees. No. 74-1169 (Decided Dec. 17, 1974). Ref. 424 Federal Reporter, 2nd Series, pages 25-36; 376 Federal Supplement, pages 125-138; 508 Federal Reporter, 2d Series, pages 547-562.

 
BACK NEXT
 

Delta Tech Systems Inc
HOME PAGE
Duke of York's Royal Military School
Royal Hibernian Military School
Reminiscences of a Queen's Army  Schoolmistress
World War I - The war to end all wars
Books and Militaria
Publications and Papers
Wellington on Waterloo
Correspondence
Related Links
Contact

© A. W. Cockerill 2005

Site Map     Contact me