Professional Documents
Culture Documents
Technology involves mechanisms, and being able to describe these mechanisms precisely
and accurately in a way the reader can understand is perhaps the most essential component
skill of writing technical reports. This skill is particularly important for those producing
documents involving specifications and instructions.
Mechanism descriptions are precise portrayals of things. Things are material devices with
two or more parts that function together to do something. Mechanisms can range in
complexity from circuit components and mechanical fasteners, to super- computers and
space shuttles, to swing sets a parent has to put together on Christmas morning.
In the Outline, notice that the primary focus in writing a mechanism description is on the
physical characteristics or attributes of a device and parts. These documents are built
around precise descriptions of size, shape, color, finish, texture, and material. Such
descriptions also normally include figures, diagrams, or photographs that directly support
the word discussion.
To show how the Outline works, we will use it to describe a relatively simple mechanism:
the 33K, one-watt carbon resistor discussed in the first chapters. The resistor is a relatively
simple mechanism; most mechanisms are much more complex. Assume, for the purpose of
illustration, that this description is for the average technical reader who requires only a
general description of the resistor.
Introduction
Following the outline, first introduce the mechanism with a technical definition and
extensions that describe its overall function and purpose:
The 33K, one-watt carbon resistor is a circuit component that impedes the flow of electrical current.
Next, use extensions to discuss any theory or operating principles necessary for the
reader to understand the description. Be careful here; think about what you are doing, for
whom you are doing it, and why you are doing it. Do not lose sight of the reader’s
knowledge and skill level or forget the purpose of the report. The goal is not to show how
smart you are, but rather to communicate the information. So, when discussing theory in a
mechanism description, a good rule is to do what is necessary, but only what is necessary.
For example, consider this theoretical discussion:
The resistor impedes the movement of free electrons, thereby generating a thermal response depending on temperature,
cross section, and length of the resistive element. The resulting resistance is measured in ohms, where a resistor has one
ohm of resistance when an applied electromotive force of one volt causes a current of one ampere to flow. In addition, the
square of the current flowing in amps, times the resistance in ohms, determines the power dissipated in watts. This
particular resistor can safely and continuously dissipate one watt of electrical energy as heat.
This discussion might be fine for readers with more specific purposes, but not for the
average person who needs only a general description. Remember: the goal here is to write
a general, informative mechanism description. The purpose is not to provide a description of
how a resistor works or to show how to measure its effect in a circuit. In addition, if this
theoretical discussion were to be used for the intended audience, several additional
concepts (such as current, voltage, and power) would have to be defined and discussed as
well.
Given the reader and purpose, the following two sentences might provide a simplified
theoretical discussion that is more appropriate:
The resistor impedes the flow of current by converting a portion of the electrical energy flowing through it into thermal
energy, or heat. This particular resistor can safely convert one watt of electrical energy into heat.
Notice that this description does not get into Ohm’s Law. (It also does not explain that if
I placed 1,000,000 volts across this resistor, it would draw 30.3 amperes of current,
resulting in the dissipation of more than 30 million watts of power, thereby generating an
inferno that would destroy my house and probably the entire neighborhood.) This
information is not relevant to describing the mechanism. It might be relevant to describing
the operation of the mechanism (or in answering the civil suits brought by the neighbors),
but that is not the purpose here.
The next step in the introduction is to describe, in general terms, the mechanism’s
overall appearance: its shape, color, material, finish, texture, and size. In this case, one
could describe the device as follows:
The 33K, one-watt carbon resistor looks like a small cylinder with wire leads extending from each end. The cylinder’s
surface is composed of smooth, brown plastic with a shiny finish. Four equally spaced color bands (three orange, one
gold) circumscribe the cylinder starting at one end.
Finally, to complete the introduction, list the mechanism’s parts in the order in which they
will be described. This listing organizes the remainder of the mechanism description.
Consequently, the decision regarding the order in which to list the mechanism’s parts is not
trivial. It effectively determines the structure for the rest of the mechanism description.
There are two ways to order the parts: spatially and functionally. Using a spatial
organization, you can move from left to right, or top to bottom, or inside out, or outside in.
Using a functional approach, you can order the parts in terms of how the parts function with
one another. Functionally, for example, you could start with the leads, which connect the
circuit to the carbon element, which is protected by the casing, and around which the color
bands are painted to indicate resistance and tolerance values. Using this approach, the final
sentence of the introduction might read as follows:
The resistor consists of the following parts: two wire leads, the carbon element, the casing, and the color bands.
Or using, for example, an inside-out spatial approach, the final sentence of the introduction
might read this way:
The resistor consists of the following parts: the carbon element, the wire leads, the casing, and the color bands.
Both approaches are fine as long as they are logical and make sense to the reader. In any
case, once the parts have been listed, move on to the discussion section, where detailed
descriptions of the parts are provided.
Discussion
The discussion section of a mechanism description precisely describes, in the necessary
detail, each part of the mechanism. It always follows the organizational pattern established
by the listing of parts at the end of the introduction. For example, using inside-out spatial
ordering, the discussion section will have four subsections: the carbon element, the leads,
the casing, and the color bands.
The discussion section is laid out in a relatively simple manner: create a subsection for
each part, then begin by describing the first part in the first subsection, and so forth.
Carbon Element
First, define the part with a technical definition:
The carbon element is the capsule of resistive material that converts electrical energy into heat.
Second, provide an extension that describes the part’s function and gives any needed
theory:
The carbon element serves as the primary active component of the resistor and provides the necessary 33,000 ohms of
resistance. The element functions by blocking, to some degree, the flow of free electrons passing through it. The energy
released by these blocked free electrons is then dissipated in the form of heat.
Next, describe the part’s shape, color, material, finish, texture, and size, using precise
measures and descriptors. Be sure to include necessary visuals such as diagrams and
photographs. Three visuals will be added to this example later in this chapter, but for now,
concentrate on describing the part’s physical attributes:
The carbon element is cylindrically shaped and is 2.4 cm long with a diameter of .31 cm. It is composed of finely ground
carbon particles mixed with a ceramic binding compound. The element is gray with a dull, matte finish.
Then, transition to the next part by showing how this part relates to it:
Leads
Define the part:
The leads are two conductive wires connected to opposite ends of the carbon element.
The leads actually have two functions. First, they provide electrical connectivity from the carbon element to the circuit; and
second, they provide a mechanical means of mounting and supporting the resistor in the circuit environment.
The leads, which have a dull, silver color and smooth texture, are composed of tinned copper wire. Each lead is four cm
long and is 20 gauge in thickness.
The leads connect to the carbon element through the ends of the casing.
Casing
Define the part:
The function of the casing is twofold. First, it physically protects nnd insulates the carbon element from the outside
environment. Second, it provides the heat-exchanging medium needed to dissipate the thermal energy generated by the
carbon element.
Color Bands
Define the part:
The color bands are visual indicators that describe the resistance and tolerance of the resistor.
Using the standard color code for commercial, four- band resistors, and starting with the band at the edge of the cylinder,
the first three bands represent the value of the resistor in ohms. The fourth band indicates the tolerance or accuracy of the
resistor.
Each color band is .1 cm wide and is circumscribed around the outside of the casing and parallel to the edge of the
casing. Each color band is smooth and shiny. The first color band, which starts flush with one end of the casing, is orange
and represents a value of 3. The second color band, which starts .1 cm away from the inside edge of the first color band,
is orange and also represents a value of 3. The third color band, which starts .1 cm away from the inside edge of the
second color band, is orange and represents a multiplier of 1000. The fourth color band, which starts .1 cm away from the
inside edge of the third color band, is gold and represents a tolerance of 5 percent.
Now that all of the parts have been described, it is time to add a conclusion.
Conclusion
The final section of the mechanism description serves two purposes: it summarizes the
description of the mechanism, and it provides a sense of finality to the document.
First, briefly summarize the mechanism’s function and relist its parts:
The 33K, one-watt carbon resistor is a circuit component that impedes the flow of electrical current through the use of a
carbon element. The resistor is made up of four parts: the carbon element, which impedes the flow of current by
converting a portion of the electrical energy applied into heat; the wire leads, which electrically connect the element to the
circuit and support the resistor mechanically; the casing, which encloses and insulates the element and dissipates heat
from it; and the color bands, which indicate the resistance and tolerance of the device.
Now give a sense of finality to the paper. Include a sentence that by tone and content
indicates to the reader that the mechanism description is complete:
Together, these parts form one of the most commonly used circuit components in electronic systems today.
This final sentence tells the reader not to look for anything else because the document is
ending; it is a courtesy to the reader.
2. Each visual has an assigned sequence number and name—such as Figure 3.3 Cutaway
view. These labels reference precisely the visuals that are included. By the way, it is a
good idea to use compound numbers—to show both the section or chapter number and
the sequence number. You will notice in the following example that the first figure is
labeled Figure 3.1.The”3” indicates that the visual occurs in the third chapter of this
book, and the “1” refers to the sequence in which the figure occurs. Numbering visuals in
this way allows adding or deleting visuals in one section without having to renumber all
the visuals in subsequent sections. Also, if possible, run separate sets of sequence
numbers for each type of visual. For example, figures should have their own set, as
should tables and photographs.
3. Each visual must be included for a purpose. In the following description, Figure 3.1
provides a visual overview of the device and labels its main parts using a cutaway for the
internal carbon element. Figure 3.2 provides an X-ray view of the resistor that shows the
various physical dimensions. Figure 3.3 shows a cutaway of the entire device.
Introduction
The 33K, one-watt carbon resistor is a circuit component that impedes the flow of
electrical current. The resistor impedes the flow of current by converting a portion of
the electrical energy flowing through it into thermal energy, or heat. This particular
resistor can safely convert one watt of electrical energy into heat.
The 33K, one-watt carbon resistor looks like a small cylinder with wire leads
extending from each end. The casing’s surface is composed of smooth, brown plastic
with a shiny finish. Four equally spaced color bands (three orange, one gold)
circumscribe the cylinder starting at one end.
The resistor consists of the following parts: the carbon element, the wire leads, the
casing, and the color bands (see Figure 3.1).
Discussion
For the following discussion, refer to Figure 3.2 for an X-ray view of the resistor’s parts,
along with its physical dimensions, and Figure 3.3 for a cutaway view of an actual resistor.
Carbon Element
The carbon element is the capsule of resistive material that converts electrical energy into
heat. The carbon element serves as the primary active component of the resistor by
providing the necessary 33,000 ohms of resistance. The element functions by blocking, to
some degree, the flow of free electrons passing through it. The energy released by these
blocked free electrons is then dissipated in the form of heat.
The carbon element is cylindrically shaped and is 2.4 cm long with a diameter of .31 cm.
It is composed of finely ground carbon particles mixed with a ceramic binding compound.
The element is gray with a dull, matte finish. The carbon element is electrically connected to
the leads.
Leads
The leads are two conductive wires connected to opposite ends of the carbon element. The
leads actually have two functions. First, they provide
electrical connectivity from the carbon element to the circuit; and second, they provide a
mechanical means of mounting and supporting the resistor in the circuit environment. The
leads, which have a dull, silver color and smooth texture, are composed of tinned copper
wire. Each lead is 4 cm long and is 20 gauge in thickness. The leads connect to the carbon
element through the ends of the casing.
Casing
The casing is a cylindrical enclosure that surrounds the carbon element. The function of the
casing is twofold. First, it physically protects and electrically insulates the carbon element
from the outside environment. Second, it provides the heat-exchanging medium needed to
dissipate the thermal energy generated by the carbon element. The casing is a brown,
plastic cylinder that is 2.5 cm long, with a .312-cm inside diameter and a .52-cm outside
diameter. It snugly fits over the carbon element. The outside of the casing is circumscribed
by four color bands.
Color Bands
The color bands are visual indicators that describe the resistance and tolerance of the
resistor. Using the standard color code for commercial, four-band resistors, and starting
with the band at the edge of the cylinder, the first three bands represent the value of the
resistor in ohms. The fourth band indicates the tolerance or accuracy of the resistor. Each
color band is .1 cm wide and is circumscribed around the outside of the casing and parallel
to the edge of the casing. Each color band is smooth and shiny.
The first color band, which starts flush with one end of the casing, is orange and
represents a value of 3. The second color band, which starts .1 cm away from the inside
edge of the first color band, is orange and also represents a value of 3. The third color band,
which starts .1 cm away from the inside edge of the second color band, is orange and
represents a multiplier of 1000. The fourth color band, which starts .1 cm away from the
inside edge of the third color band, is gold and represents a tolerance of 5 percent.
Conclusion
The 33K, one-watt carbon resistor is a circuit component that impedes the flow of electrical
current through the use of a carbon element. The resistor is made up of four parts: the
carbon element, which impedes the flow of current by converting a portion of the electrical
energy applied into heat; the wire leads, which electrically connect the element to the circuit
and support the resistor mechanically; the casing, which encloses and insulates the element
and dissipates heat from it; and the color bands, which indicate the resistance and tolerance
of the device. Together, these parts form one of the most commonly used circuit
components in electronic systems today.
Introduction
Define the mechanism with a technical definition (see Chapter 2) and add extensions to
discuss any theory or principles necessary for the reader to understand what you are
saying. Always make sure you add only what the reader needs for the purpose at hand.
If the reader does not need any theory or operating principles, do not provide any.
Describe the mechanism’s overall function or purpose.
Describe the mechanism’s overall appearance in terms of its shape, color, material,
finish, texture, and size.
List the mechanism’s parts in the order in which you plan to describe them.
Discussion
Part #1
o Define the first part with a technical definition, adding extensions as needed to deal
with theory or operating principles.
o Describe the part’s overall function or purpose.
o Describe the part’s shape, color, material, finish, texture, and size using precise
measures and descriptors. Also be sure to use figures, diagrams, and photographs as
necessary.
o Transition from this part to the next part.
Parts #2—n
o For each remaining part, repeat the pattern of defining, describing, and transitioning
established for Part #1.
Conclusion
Briefly summarize the mechanism’s function and relist the parts described.
Give a sense of finality to the paper.