The Seeming Contradiction of Precise Detail. Detailed explanations of objects, places, or...

24
The Seeming Contradiction of Precise Detail Technical Description s

Transcript of The Seeming Contradiction of Precise Detail. Detailed explanations of objects, places, or...

Page 1: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

The Seeming Contradiction of Precise Detail

Technical Descriptions

Page 2: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

Detailed explanations of objects, places, or processes, written for various purposes in the technical workplaceDescribe products for

quality control or saleApplications for patentsEngineering

Specifications Field

Notes/Observations

Definition

Page 3: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

General Audience (assume little to know previous experience)

You are not actively considering Secondary, Tertiary, or Gatekeeping readers

I am concerned with Layout, Adherence to Outline, Writing Style, and Thoroughness

Your Purpose

Page 4: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

Take MeasurementsCreate or Locate VisualsAsk Subject Matter

ExpertsOr use something you’re

a SME withMake sure research is

written by SMEsUse your senses

Looks, sounds, smells, tastes, textures, colors

Research

Page 5: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

1.Title

2. IntroductionDefinition of SubjectPurpose Statement

Main PointImportance of Subject

Overall DescriptionList of Major Parts

3. Major Part/StepDefinition/Purpose of Part

Minor Part

4. Major Part/StepDefinition/Purpose of Part

Minor Part

5. Major Part/StepDefinition/Purpose of Part

Minor Part

6. ConclusionImportant of Subject

Future of SubjectOne Operating Cycle

Outline

Page 6: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

1.TitleTitle:

Be Specific and Precise

Description of the Mars Exploration Rover

Specifications for the XC-9000 Microprocessor

The Wii Remote: An Inside Look at the Controller

When in doubt: Technical Description of __________

• Top of Page• Bolded or sized to provide

emphasis• Sans-Serif font preferred

Page 7: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

2. IntroductionDefinition of SubjectPurpose Statement

Main PointImportance of Subject

Overall DescriptionList of Major Parts

Definition of Subject: (the first sentence of you document)

• Term• Class• Characteristics that distinguish

from other class members

The Hamilton Beach Big Mouth E-Cigarette is an electronic smoking device that uses an atomizer to vaporize glycerin-based oil to produce a flavorful smoke. “The Wii Remote is a video game

controller that uses an optical sensor and acclerometer to allow interaction with and manipulation of objects on screen through pointing and tilting gestures.”

Page 8: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

2. IntroductionDefinition of SubjectPurpose Statement

Main PointImportance of Subject

Overall DescriptionList of Major Parts

Purpose Statement:

Dependent on situation. It should explain that you are describing something, but also linked to something larger.

“This description will detail the parts of this E-cigarette that contribute to understanding the vaping process.”

“This description will highlight the unique aspects of the Wii remote by focusing on the motion and sensory technology that creates new styles of gameplay.”

Page 9: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

2. IntroductionDefinition of SubjectPurpose Statement

Main PointImportance of Subject

Overall DescriptionList of Major Parts

Main Point: what will your description support or prove?

“E-Cigarettes use this technology to offer a safer alternative to smoking burning tobacco.”

“Upon its introduction, the Wii Remote was a revolutionary way to interact with video games.”

Importance of Subject: why should anyone care to get to know the item In this detail?

“A user who understands the function of each part, and how to maintain their cleanliness, will be in a better position to get the most life out of their purchase.”

“Understanding how the Wii Remote works illustrates the inspiration it provided for subsequent game console innovations.”

Page 10: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

2. IntroductionDefinition of SubjectPurpose Statement

Main PointImportance of Subject

Overall DescriptionList of Major Parts

Overall Description: A visual description of the entire object. Pretend you’re describing it to a blind person.

“The Hamilton Beach Big Mouth E-Cigarette consists of a long cylindrical battery (available in multiple colors) with a rotating disk at its bottom to change voltage settings. A transparent, cylindrical tank screws into the top of the battery and has a rotating ring with an air hole that selects air intake settings. The tank is topped with a tapered mouthpiece with a hole at its end where the water vapor is inhaled.”

“The Wii Remote is a rectangular device that fits easily in one hand. It has three buttons on its face and a trigger on its underside. The light sensor sits at the front of the controller while the bottom has an input for the separate nunchuk controller.”

List of Major Parts:

This is where you’ll preview the main headings coming up in the next sections.

Page 11: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

The Hamilton Beach Big Mouth E-Cigarette is an electronic smoking device that uses an atomizer to vaporize glycerin-based oil to produce a flavorful smoke. This description will detail the parts of this E-cigarette that contribute to understanding the vaping process. E-Cigarettes use this technology to offer a safer alternative to smoking burning tobacco. A user who understands the function of each part, and how to maintain their cleanliness, will be in a better position to get the most life out of their purchase. The Hamilton Beach Big Mouth E-Cigarette consists of a long cylindrical battery (available in multiple colors) with a rotating disk at its bottom to change voltage settings. A transparent, cylindrical tank screws into the top of the battery and has a rotating ring with an air hole that selects air intake settings. The tank is topped with a tapered mouthpiece with a hole at its end where the water vapor is inhaled.

The parts discussed in this document are:

- Battery- Atomizer- Fluid Tank-Mouthpiece

Page 12: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

From one direction to another (a pencil)

From the inside out (a video game controller)

From top to bottom (a lamp)

Partitioning the Subject- and

discussing in a logical order

Page 13: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

6. ConclusionImportant of Subject

Future of SubjectOne Operating Cycle

Conclusion:

Keep it:• Short• Concise

• Remind reader of importance• Look to the future of this

product or process

Some technical descriptions have no conclusion- they end after the final part. Yours should have one.

Page 14: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

Use simple words/avoid jargon

Focus on “need to know” details

Keep sentences short (breathing length)

Do not use “I” Use bolding and bullets

rhetorically Remove qualifier words

(“very,” easy,” “hard,” “amazing”)

Remove subjective/relevant words (“large,” “small,” “near”

Think about color, texture, taste, sound, smell, placement, connections, etc.

Notes on Style

Page 15: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

The jaw is shaped similar to an hourglass, though less pronounced in its curvature, with each side of the plates curving in near the center of the plates’ length .

Metaphors

Page 16: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

What materials is it made out of (be specific)?What are the dimensions?What is its shape?What is its color(s)?What is that part’s function? Is the part connected to something else? How?Does it move? How? Why?

Descriptive Sections

Page 17: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.
Page 18: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

Left & Right Click Covers

Scroll WheelCasingCordPlug (USB or PS/2)Optical Sensor

Know Your Part Names

Page 19: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

Scroll Wheel

The scroll wheel is a small wheel overlaid with rubber (or a similar low friction material) that is ‐located between the right and ‐left click covers and that ‐ connects to the internal circuit board though a system of gears. The wheel is positioned so it can be easily turned by one finger while the mouse is being operated. The wheel also allows the user to navigate up and down in a user interface window.

Research your parts

Page 20: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.
Page 21: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

Lead RodWooden BarrelEraser Ferrule

What questions might we start asking ourselves about these parts?

Parts of the Pencil

Page 22: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

The pencil is a writing instrument that uses erasable lead rods to draw or write text, images, and symbols on mediums such as paper and wood. The pencil is commonly used for drawing pictures and writing text on paper.

Even “Simple” Items Need a

Detailed Opening Line

Page 23: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.
Page 24: The Seeming Contradiction of Precise Detail.  Detailed explanations of objects, places, or processes, written for various purposes in the technical workplace.

Which are Needed?