Lannon, Chapter 21

CHAPTER 21: TECHNICAL DESCRIPTIONS AND SPECIFICATIONS

Purposes and Types of Technical Description
Descriptions are used to help users understand what a product does, how it works, what it looks like, etc. Two main types: [1] product [2] process.

Objectivity in Technical Description
Descriptions can be objective or subjective, meaning either an impartial view or express feelings or sentiments. Unless promotional, technical documents should be objective. Help visualize the product with details. Be precise and use informative language.

Elements of a Usable Description
Have a title that's clear and informs the reader of the subject. Have the appropriate level of technical terms for your audience. Don't bore them with facts that aren't needed. Visuals are good to help the audience visualize the product and understand the processes. Sequences help depict what happens through the different steps of the process. A spatial sequence show what it a product does and how it looks; while a functional sequence shows how it works. A chronological sequence shows how it's assembled and how it happens.

An Outline and Model for Product Description 
An outline helps organize and present what must be covered for the user. The general description gives an overview of the product- what they need to know to use it. Body of text is for describing major parts. The summary and operating description explains how the parts work together.

Specifications
Specifications are very important because the wrong specs can cause a product to fail. specifications go through five main groups of people: the customers, the designer, the contractor/manufacturer, the supplier, the workforce and the inspectors.