Technical definitions description
- 1. + Technical Definitions and Descriptions Technical Writing – Thompson 1
- 2. 2 + Technical Definitions Name - objects, - events, - processes, - phenomena Used in complex ways May include brief explanatory information with supporting graphics Technical Writing - Thompson
- 3. + 3 Example of Descriptive Definition A paper micrometer is a small measuring instrument used to measure the thickness of a piece of paper. The micrometer is roughly the size of a regular stapler and has four main parts: 1) frame, 2) dial, 3) hand lever, and 4) piston. The total weight of the instrument is 8 pounds. A micrometer has applications for the production of paper as well as printing and publishing industries. Technical Writing - Thompson
- 4. 4 + Technical Definitions are used to: Name a new development or a new technology in a technical field. A Protected Membrane Roof (PMR) system using styrofoam insulation shields and protects a roof’s waterproof membrane unlike a traditional roof system that does not cover the membrane. Technical Writing - Thompson
- 5. 5 + Technical Definitions are also used To help specialists communicate with less knowledgeable readers. For example, a manual explaining how to tune up a car includes definitions of parts and tools. Technical Writing - Thompson
- 6. 6 + Technical Definitions are also used By specialists when communicating with readers who have a high level of technical expertise to: Clarify the context Reduce ambiguity Technical Writing - Thompson
- 7. 7 + We often think of dictionaries when using the word “definition” Phenylephrine. n. An adrenergic drug, C9H13NO2, that is a powerful vasoconstrictor and is used to relieve nasal congestion, dilate the pupils, and maintain blood pressure during anesthesia. Definition is from American Heritage High School Dictionary Technical Writing - Thompson
- 8. 8 + Context where technical term is sufficient Medical article describing methodology: Participantsin the study were given 3 mg. of Phenylephrine prior to anesthestic. Technical Writing - Thompson
- 9. 9 + Parenthetical Although blight resistance has been identified in both Kabuli (large, white seeded) and Desi (small, dark seeded) chickpeas, resistance is usually associated with small seed size. Winter dormancy in black bears (Ursus americanus) is likely an adaptation to predictable seasonal food shortages. The required gravel equivalent (GE) for the estimated traffic loading and sub grade conditions is 575 millimeters. Our recommendations are to provide a minimum GE of 660 millimeters because . . . Technical Writing - Thompson
- 10. 10 + Sentence Definition Formula: Term + Class/Category + Features/Details Aschoyta rabiei (term) is a fungus (class or category) that causes severe chickpea blight. (details) Technical Writing - Thompson
- 11. 11 + Sentence Definition in a Paragraph In 1983, Aschoyta rabiei, a fungus that causes severe chickpea blight, was discovered near Pullman, Washington. Because this fungus has a very limited capacity to survive on other hosts, it was most likely introduced on chickpea seed imported from outside the region. Technical Writing - Thompson
- 12. 12 + Sentence Definition in a Paragraph Whirling disease is a parasitic infection responsible for dramatic declines in wild trout populations in several Western rivers. Infected fish often exhibit darkened tails (blacktail), skeletal deformities in the head and spine, and swim in a tail-chasing or whirling type motion from which the disease gets its name. Technical Writing - Thompson
- 13. 13 + Sentence Definition in a Paragraph The California condor (Gymnogyps californianus) is a member of the Ciconiidae family commonly known as the American vultures. At one time condors were included in the Cathartidae family in the order Falconiformes. Recently, however, taxonomists have concluded that vultures are more closely related to storks and have thus placed condors in a new taxonomic structure including them with the order Ciconiiformes (ITIS 2006). Technical Writing - Thompson
- 14. 14 + Technical Descriptions Explain How something works - design - mechanism Methodology - processes - procedures Physical aspects - location - organism Technical Writing - Thompson
- 15. 15 + Questions that technical descriptions answer for an audience What does it do? What does it look like? What is it made of? How does it work? How has it been put together? Technical Writing - Thompson
- 16. 16 + Describing a Method (Process) Five exploratory borings will be drilled in or around the perimeter of the proposed development area during Phase I of geotechnical exploration. The borings will be located relative to the existing site features and our understanding of the preliminary design plans. Technical Writing - Thompson
- 17. 17 + Describing a Method (Procedure) Hair was cut in five to ten locations (20-50 strands of hair per location in the occipital region of the scalp) with stainless steel surgical scissors. Only the 5-cm segment of hair next to the skin was used. The hair sample was placed in a seal-able plastic bag and labeled. Sample sizes of sufficient quantity were divided into duplicate pairs. Technical Writing - Thompson
- 18. 18 + Describing a Location The project site is located on the University of Idaho campus in Moscow, Idaho. Specifically, the property is located in the Southwest Quarter of the Northeast Quarter of Section 18, Township 39 North, Range 5 West of the Boise Meridian in Latah County, Idaho. Technical Writing - Thompson
- 19. 19 + Weak Descriptions: Example from an Engineering Review The proposal fails to clearly define the list of radionuclides or toxic waste materials that are to be incinerated. While tables 3, 5, and 6 list the radionuclide and toxic materials contained in the stored wastes, Appendix 2 shows a different inventory. In addition, selection criteria for types of materials that qualify for incineration are not described. As a result, we advise against the proposed project. Technical Writing - Thompson
- 20. + 20 Technical Specifications Similar to technical descriptions but differ in format. Specifications often rely heavily on visual representation such as an exploded drawing and do not use complete sentences but short phrases or terms to label the various parts. Sometimes specifications are listed in a table format. Used by audiences with varying levels of technical expertise. Technical Writing - Thompson
- 21. 21 + Technical Specs in Table Format Technical Writing - Thompson
- 22. 22 + Technical Specs in an Exploded Drawing Technical Writing - Thompson
- 23. + Common Writing Problems Technical Definitions and Technical Descriptions Technical Writing - Thompson 23
- 24. 24 + Confusing Methods with Instructions Instructions are intended for the user to carry out a task. Method descriptions provide explanation of what will be or what has been done. Both instructions and method descriptions use a chronological pattern but for different purposes Although the description of a method may be chronological, it is not intended to be used by readers to carry out a task. Technical Writing - Thompson
- 25. 25 + Example 1: What Not to Do in a Methods Section To measure the cone angle: Step 1: Take pictures of the flame cone using a digital camera. Step 2: Download the pictures to a computer. Step 3: Open the pictures in SolidWorks. Step 3: Use the dimensioning tool to measure cone angle. Technical Writing - Thompson
- 26. 26 + Example 1 Revised A digital camera was used to take pictures of the flame cone. The pictures were downloaded to a computer and opened in SolidWorks where the dimensioning tool was used to measure the cone angle. Technical Writing - Thompson
- 27. 27 + Example 2: What Not to Do in a Methods Section In order to understand the methodology you must first understand the elements of a storm we are concerned with: 1. Sea Surface Temperature (SST). As mentioned water at or above 26.5o C is required for a storm to form. Also they tend to weaken over cooler water. 2. Sea Surface Rain Fall (SSR). This will allow for prediction of flooding and related events. 3. Sea Surface Wind Direction and Velocity (SSW). This will allow for predictions of structural damage and other wind related damage. Next you must understand the satellites used to monitor these variables as well as the buoys. In terms of the satellites each requires a totally different sensor and at present at totally different satellite. Currently there no single satellite platform that contains all the sensors required for monitoring these storm elements. As such three different satellite missions were used. Technical Writing - Thompson
- 28. 28 + Example 2 Revised Three different satellite missions were used to determine Sea Surface Temperature (SST), Sea Surface Rain Fall (SSR), and Sea Surface Wind Direction and Velocity (SSW). Technical Writing - Thompson
Editor's Notes
- #3: Slide 2 Strictly speaking, “to define” something means to name it. Technical definitions and descriptions may seem to be the same thing because a defining something very often requires providing descriptive information to explain what it does or how it is used. Unlike definitions, however, a technical description involves specific details of physical properties that go beyond what something does or how it is used.
- #4: Slide 3Here is an example of a technical definition that is descriptive.Notice how this technical definition, while descriptive, is limited. We are not given the material it is made of nor other details that would be in a technical description of a paper micrometer.
- #5: Slide 4In this case, the PMR system is compared to what it is not “the traditional roof system.” In the explanation that follows this sentence, more information is provided as to the difference and why the PMR system is better.
- #8: Slide 7Technical and professional documents use definitions, however, in much more complex ways. Dictionaries provide explanations but not context. For the most part, you want to avoid the typical dictionary or textbook definition in workplace writing. In contexts where the audience is familiar with the technical terminology, then a name may be all that is needed.Technical and professional documents use definitions, however, in much more complex ways. Dictionaries provide explanations but not context. For the most part, you want to avoid the typical dictionary or textbook definition in workplace writing. In contexts where the audience is familiar with the technical terminology, then a name may be all that is needed.
- #9: Slide 8Here, the technical definition is understood by readers because they share the same level of technical knowledge, so the name (i.e. term) is all that’s needed.
- #10: Slide 9It is often, however, important to provide a very brief definition set off by parentheses to both remind readers as to what the term means and to clarify how the term will be used or vice versa. Context and the writing situation determine when to use a parenthetical definition.Notice the difference in how each writer here uses the parenthetical definition. In the first instance, “Kabuli” and “Desi” are naming something and that something is briefly described in the parentheses. The parentheses signal to the reader that when the terms “Kabuli” and “Desi” are used in any text the writer is using them to name large, white seeded and small, dark seeded chickpeas. In the second instance, the writer is placing the universal scientific term for black bears in parentheses (the Latin term) because the name “black bear” is not used universally. In this case, the writer wants to be certain readers know that “black bear” in this technical document refers to this specific species of bear. The writer might have chosen to use the Latin terminology throughout the article, but made the choice to use “black bears” to perhaps make the article more accessible to readers. In the final case, the writer chooses to place the acronym “GE” that identifies the descriptive phrasing “required gravel equivalent” in a manner that signals to the reader how GE will be used throughout the document. In many cases, parenthetical definitions are used to reduce the possibility of readers misunderstanding or misreading the document.
- #11: Slide 10 Sometimes, a sentence definition works best. In this case, it is typical to use this formula for creating a sentence definition.
- #12: Slide 11Notice how the sentence definition from the prior slide is altered slightly to incorporate it into the first sentence.
- #13: Slide 12At other times, the sentence definition serves as the topic sentence and is used exactly as presented in the formula. Notice how the explanatory information is descriptive.
- #14: Slide 13Notice how this writer uses the sentence definition at the beginning of a paragraph aiming at clarifying how the classification family of this animal has changed.
- #26: Slide 26 Here is an example of writing that is didactic which means writing that is aimed at teaching the audience. It sounds as if it came from a textbook (and a poorly written one at that).
- #28: Slide 27Again, the writer is being didactic and the writing is not focused on describing methodology but on teaching a reader.