SlideShare uma empresa Scribd logo
1 de 29
Writing Technical
Definitions
Technical Definitions
   Describe and define new products and
    services

   Introduce new information to reader
    in clear and effective ways

   Allow experts and specialists to
    communicate with a more generalized
    audience
Planning for Audience (p. 453)
   Identify stakeholders

   Determine the amount and kind
    of technical language or jargon to
    use

   Acknowledge differences in
    language
Planning for Problem
& Purpose (p. 454)
   Explanatory Definitions
     To explain a concept, thing, or idea to readers

   Operational Definitions
     To enable audiences to engage in an activity or
      operation

   Deliberative Definitions
     To clarify the meanings of terms, ideas, and concepts
Types of Definitions

               Short, Parenthetical &
                      Extended
Short Definitions
   Are typically only a sentence or two to
    provide meaning for the reader

   Are usually categorical, placing the
    term in a category of similar terms

   May provide descriptions of use or
    other distinguishing characteristics of
    the term
Parenthetical Definitions
   Are typically only a sentence or two to
    provide meaning for the reader

   Are usually categorical, placing the
    term in a category of similar terms

   May provide descriptions of use or
    other distinguishing characteristics of
    the term
Extended Definitions

   May use the different kinds of
    definitions outlined earlier, like
    descriptions or visuals

   Exist in lengthier texts where
    audiences need detailed
    information
Researching & Drafting
Researching Definitions

   Is often necessary to construct
    definitions that deal with
    unfamiliar ideas and concepts

   Produces more accurate and
    effective definitions
Drafting Definitions
   Includes putting together an initial definition
    and placing it in the context of the document

   Involves fitting the definition into the scope
    of the document

   This is harder than it seems – where does it
    fit and how? Where would you put this so it
    made sense for your audience and purpose?
Building your Definition
Kinds of Definitions
   Definitions that describe

   Definitions that compare and contrast

   Definitions that classify

   Definitions that provide examples

   Definitions that illustrate with visuals
Definitions that Describe
   Often work by describing what something looks like, feels
    like, sounds like, or smells like

   Often appeal to the readers’ visual senses by describing
    size, shape, and appearance

   Often describe what the thing does, how it is used, and to
    what purpose
Definitions that Describe
Example:

Aielron:
  A small, slender, hinged section on the outer portion of a
  wing, used to control an aircraft’s rolling and banking
  movements. Ailerons usually work in opposition: as the
  left aileron is deflected upward, the right is deflected
  downward, and vice versa.
Definitions that Compare &
Contrast
   Give similarities or differences between subjects

   Often compare or contrast something unfamiliar with
    something the audience knows

   Provide a frame of reference by giving context
Definitions that Compare &
Contrast
Example:

Flash Drive:
  A small, lightweight, portable Universal Serial Bus (USB)
  device that allows users to store, carry, and transfer
  programs and files, much like the older 3.5-inch floppy
  disk. The flash drive, however, differs from the older
  floppy disks; it is much smaller (only 70 mm long, 30 mm
  wide, and about 11 mm in height) and more durable and
  contains no internal moving parts.
Definitions that Classify
   Categorize a term within a larger group in order to provide
    a context or association

   Can be problematic because not everyone agrees on the
    meaning of particular categories
Definitions that Classify
Example:

  Someone writing a field guide to birds and animals in
  Texas could safely assume that many people would not
  know what an ocelot is.

  However, if the writer begins by defining an ocelot as a
  kind of wildcat, much of the mystery of the term
  disappears because most if not all readers can identify a
  wildcat.
Definitions that Provide Examples
   Provide a clear-cut and familiar example of the thing or
    concept being defined

   Should use examples familiar to the audience

   Frequently clarify abstract terms
Definitions that Provide Examples
Example:

  Sports car might be defined as vehicles with sleek body
  styles, superior acceleration, little cargo space, and so
  forth.

  While such a definition would be useful, any definition of
  sports car would benefit by providing specific examples:
  Chevrolet Corvette, Dodge Viper, or Porsche 911, for
  example.
Definitions that Illustrate
with Visuals
   Give readers visual prompts to give clear and quick
    understanding

   Benefit the reader by including a picture in addition to a
    written definition

   Help explain concepts that one cannot actually see with
    the naked eye
Definitions that Illustrate
with Visuals
Ethics & Warnings
Ethics in Technical Definitions
   Be aware of how definitions can potentially mislead,
    confuse, or cause danger or harm.

   Ensure that readers have all the information necessary to
    use the product safely.

   Rely on correct, unbiased information to help audiences
    make decisions.
Ethics in Technical Definitions
   Full Disclosure
     Writers have not omitted any information that an
      audience needs to comprehend the term

   Appropriate Style
     Select a style that should be clearly grasped by the
      target audience
Common Mistakes
   Circular Definitions
     Using the term in defining it

   Synonyms
     Using a similar term gives no useful information

   Not User-Oriented
     Failing to take the users’ or audiences’ knowledge,
      background, and needs into account
Start the Process
Steps:
   Identify the topic of your technical definition
   Identify your audience
   Identify purpose of definition (explanatory,
    operational, deliberative)
   Select the type of combination of types of definitions
    that will work best for your topic, audience, and
    purpose.
   Research your topic
   Draft and Revise (pg 458)

Mais conteúdo relacionado

Mais procurados

Q2-WK1-Wika sa Panayam at Balita sa Radyo at Telebisyon.pptx
Q2-WK1-Wika sa Panayam at Balita sa Radyo at Telebisyon.pptxQ2-WK1-Wika sa Panayam at Balita sa Radyo at Telebisyon.pptx
Q2-WK1-Wika sa Panayam at Balita sa Radyo at Telebisyon.pptx
MichaelJohnVictoria1
 
English LP- Bias and Prejudice Grade 9.docx
English LP- Bias and Prejudice Grade 9.docxEnglish LP- Bias and Prejudice Grade 9.docx
English LP- Bias and Prejudice Grade 9.docx
AndreiBana1
 

Mais procurados (20)

Reading and Writing - Text as a Connected Discourse
Reading and Writing - Text as a Connected DiscourseReading and Writing - Text as a Connected Discourse
Reading and Writing - Text as a Connected Discourse
 
EAPP_Paraphrasing and Summarizing
EAPP_Paraphrasing and SummarizingEAPP_Paraphrasing and Summarizing
EAPP_Paraphrasing and Summarizing
 
Newspaper parts
Newspaper partsNewspaper parts
Newspaper parts
 
Grade-8-signals-that-indicate-coherence
Grade-8-signals-that-indicate-coherenceGrade-8-signals-that-indicate-coherence
Grade-8-signals-that-indicate-coherence
 
Q2-WK1-Wika sa Panayam at Balita sa Radyo at Telebisyon.pptx
Q2-WK1-Wika sa Panayam at Balita sa Radyo at Telebisyon.pptxQ2-WK1-Wika sa Panayam at Balita sa Radyo at Telebisyon.pptx
Q2-WK1-Wika sa Panayam at Balita sa Radyo at Telebisyon.pptx
 
English LP- Bias and Prejudice Grade 9.docx
English LP- Bias and Prejudice Grade 9.docxEnglish LP- Bias and Prejudice Grade 9.docx
English LP- Bias and Prejudice Grade 9.docx
 
Critical Reading as Reasoning
Critical Reading as ReasoningCritical Reading as Reasoning
Critical Reading as Reasoning
 
(Eng 111) parts of a newspaper
(Eng 111) parts of a newspaper(Eng 111) parts of a newspaper
(Eng 111) parts of a newspaper
 
TECHNICAL AND OPERATIONAL DEFINITIONS FINAL.pptx
TECHNICAL AND OPERATIONAL DEFINITIONS FINAL.pptxTECHNICAL AND OPERATIONAL DEFINITIONS FINAL.pptx
TECHNICAL AND OPERATIONAL DEFINITIONS FINAL.pptx
 
Outlining
OutliningOutlining
Outlining
 
News Reports, Speeches, and Panel Discussion
News Reports, Speeches, and Panel DiscussionNews Reports, Speeches, and Panel Discussion
News Reports, Speeches, and Panel Discussion
 
LESSON 1- Patterns of Development in Writing Across Disciplines.pptx
LESSON 1- Patterns of Development in Writing Across Disciplines.pptxLESSON 1- Patterns of Development in Writing Across Disciplines.pptx
LESSON 1- Patterns of Development in Writing Across Disciplines.pptx
 
claim of value
claim of valueclaim of value
claim of value
 
Technical definitions description
Technical definitions descriptionTechnical definitions description
Technical definitions description
 
Parts of a school paper (English 14)
Parts of a school paper (English 14)Parts of a school paper (English 14)
Parts of a school paper (English 14)
 
lesson 6 Cohesive-Devices FINAL.pptx
lesson 6 Cohesive-Devices FINAL.pptxlesson 6 Cohesive-Devices FINAL.pptx
lesson 6 Cohesive-Devices FINAL.pptx
 
7 communicative strategies
7 communicative strategies7 communicative strategies
7 communicative strategies
 
-EAPP-Concept-Paper-ppt.ppt
-EAPP-Concept-Paper-ppt.ppt-EAPP-Concept-Paper-ppt.ppt
-EAPP-Concept-Paper-ppt.ppt
 
Types of speech styles
Types of speech stylesTypes of speech styles
Types of speech styles
 
Explicit and implicit claims in a text
Explicit and implicit claims in a textExplicit and implicit claims in a text
Explicit and implicit claims in a text
 

Semelhante a Writing technical definitions

Chapter 18 final presentation
Chapter 18 final presentationChapter 18 final presentation
Chapter 18 final presentation
jsolis8
 
Definition purposes to know the real meaning of definition
Definition purposes to know the real meaning of definitionDefinition purposes to know the real meaning of definition
Definition purposes to know the real meaning of definition
mikyladupa
 
Rhetorical Considerations for Presentation Design
Rhetorical Considerations for Presentation DesignRhetorical Considerations for Presentation Design
Rhetorical Considerations for Presentation Design
Amy Goodloe
 
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptionsEngl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Zachary Williamson
 
Deliverable Length300-500 wordsChoose one of the following to.docx
Deliverable Length300-500 wordsChoose one of the following to.docxDeliverable Length300-500 wordsChoose one of the following to.docx
Deliverable Length300-500 wordsChoose one of the following to.docx
cargillfilberto
 
Introduction to technical writing
Introduction to technical writingIntroduction to technical writing
Introduction to technical writing
Adam Tablante
 

Semelhante a Writing technical definitions (20)

Chapter 18 final presentation
Chapter 18 final presentationChapter 18 final presentation
Chapter 18 final presentation
 
Definition purposes to know the real meaning of definition
Definition purposes to know the real meaning of definitionDefinition purposes to know the real meaning of definition
Definition purposes to know the real meaning of definition
 
Methods of Definition
Methods of DefinitionMethods of Definition
Methods of Definition
 
Controlled Vocabulary.pptx
Controlled Vocabulary.pptxControlled Vocabulary.pptx
Controlled Vocabulary.pptx
 
Definition
DefinitionDefinition
Definition
 
Definition
DefinitionDefinition
Definition
 
Rhetorical Considerations for Presentation Design
Rhetorical Considerations for Presentation DesignRhetorical Considerations for Presentation Design
Rhetorical Considerations for Presentation Design
 
Technical writing
Technical writingTechnical writing
Technical writing
 
Sph 107 Ch 8
Sph 107 Ch 8Sph 107 Ch 8
Sph 107 Ch 8
 
Communication_Audience_analysis_presentation_2.pptx
Communication_Audience_analysis_presentation_2.pptxCommunication_Audience_analysis_presentation_2.pptx
Communication_Audience_analysis_presentation_2.pptx
 
02 proposal report_preparation_2nd_sem
02 proposal report_preparation_2nd_sem02 proposal report_preparation_2nd_sem
02 proposal report_preparation_2nd_sem
 
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptionsEngl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptions
 
The Role of Thesauri in Data Modeling
The Role of Thesauri in Data ModelingThe Role of Thesauri in Data Modeling
The Role of Thesauri in Data Modeling
 
Professional Communication in Computing - Writing
Professional Communication in Computing - WritingProfessional Communication in Computing - Writing
Professional Communication in Computing - Writing
 
Deliverable Length300-500 wordsChoose one of the following to.docx
Deliverable Length300-500 wordsChoose one of the following to.docxDeliverable Length300-500 wordsChoose one of the following to.docx
Deliverable Length300-500 wordsChoose one of the following to.docx
 
Introduction to technical writing
Introduction to technical writingIntroduction to technical writing
Introduction to technical writing
 
PRINCIPLES OF SPEECH WRITING.pptx
PRINCIPLES OF SPEECH WRITING.pptxPRINCIPLES OF SPEECH WRITING.pptx
PRINCIPLES OF SPEECH WRITING.pptx
 
Advice on academic writing
Advice on academic writingAdvice on academic writing
Advice on academic writing
 
REPORT WRITING
REPORT WRITINGREPORT WRITING
REPORT WRITING
 
Planning for presentation
Planning for presentationPlanning for presentation
Planning for presentation
 

Mais de Ariadne Rooney

Mais de Ariadne Rooney (20)

Literacy Narrative Paper Overview
Literacy Narrative Paper OverviewLiteracy Narrative Paper Overview
Literacy Narrative Paper Overview
 
Writing the literature review
Writing the literature reviewWriting the literature review
Writing the literature review
 
Literacy Narrative Paper Overview
Literacy Narrative Paper OverviewLiteracy Narrative Paper Overview
Literacy Narrative Paper Overview
 
Mark twain overview
Mark twain overviewMark twain overview
Mark twain overview
 
American Literature 1865-1914 Overview
American Literature 1865-1914 OverviewAmerican Literature 1865-1914 Overview
American Literature 1865-1914 Overview
 
Literacy narrative paper overview
Literacy narrative paper overviewLiteracy narrative paper overview
Literacy narrative paper overview
 
Audience overview
Audience overviewAudience overview
Audience overview
 
English 335 Project 3 overview
English 335 Project 3 overviewEnglish 335 Project 3 overview
English 335 Project 3 overview
 
Background essay overview lecture
Background essay overview lectureBackground essay overview lecture
Background essay overview lecture
 
Screencasting instructions
Screencasting instructionsScreencasting instructions
Screencasting instructions
 
Project 4 proposed program
Project 4 proposed programProject 4 proposed program
Project 4 proposed program
 
Ch10 arguing a position-notes
Ch10 arguing a position-notesCh10 arguing a position-notes
Ch10 arguing a position-notes
 
Passive voice quick presentation
Passive voice quick presentationPassive voice quick presentation
Passive voice quick presentation
 
Ralph waldo emerson
Ralph waldo emersonRalph waldo emerson
Ralph waldo emerson
 
Writing the Literature Review
Writing the Literature ReviewWriting the Literature Review
Writing the Literature Review
 
Inventing argument chapter 3 logic lecture
Inventing argument chapter 3 logic lectureInventing argument chapter 3 logic lecture
Inventing argument chapter 3 logic lecture
 
Inventing argument chapter 2 lecture
Inventing argument chapter 2 lectureInventing argument chapter 2 lecture
Inventing argument chapter 2 lecture
 
Inventing Arguments: Chapter 1 Lecture
Inventing Arguments:  Chapter 1 Lecture Inventing Arguments:  Chapter 1 Lecture
Inventing Arguments: Chapter 1 Lecture
 
Prosepoetrydrama English 126 Week 1 Lecture
Prosepoetrydrama English 126 Week 1 LectureProsepoetrydrama English 126 Week 1 Lecture
Prosepoetrydrama English 126 Week 1 Lecture
 
Audience
AudienceAudience
Audience
 

Writing technical definitions

  • 2. Technical Definitions  Describe and define new products and services  Introduce new information to reader in clear and effective ways  Allow experts and specialists to communicate with a more generalized audience
  • 3. Planning for Audience (p. 453)  Identify stakeholders  Determine the amount and kind of technical language or jargon to use  Acknowledge differences in language
  • 4. Planning for Problem & Purpose (p. 454)  Explanatory Definitions  To explain a concept, thing, or idea to readers  Operational Definitions  To enable audiences to engage in an activity or operation  Deliberative Definitions  To clarify the meanings of terms, ideas, and concepts
  • 5. Types of Definitions Short, Parenthetical & Extended
  • 6. Short Definitions  Are typically only a sentence or two to provide meaning for the reader  Are usually categorical, placing the term in a category of similar terms  May provide descriptions of use or other distinguishing characteristics of the term
  • 7. Parenthetical Definitions  Are typically only a sentence or two to provide meaning for the reader  Are usually categorical, placing the term in a category of similar terms  May provide descriptions of use or other distinguishing characteristics of the term
  • 8. Extended Definitions  May use the different kinds of definitions outlined earlier, like descriptions or visuals  Exist in lengthier texts where audiences need detailed information
  • 10. Researching Definitions  Is often necessary to construct definitions that deal with unfamiliar ideas and concepts  Produces more accurate and effective definitions
  • 11. Drafting Definitions  Includes putting together an initial definition and placing it in the context of the document  Involves fitting the definition into the scope of the document  This is harder than it seems – where does it fit and how? Where would you put this so it made sense for your audience and purpose?
  • 13. Kinds of Definitions  Definitions that describe  Definitions that compare and contrast  Definitions that classify  Definitions that provide examples  Definitions that illustrate with visuals
  • 14. Definitions that Describe  Often work by describing what something looks like, feels like, sounds like, or smells like  Often appeal to the readers’ visual senses by describing size, shape, and appearance  Often describe what the thing does, how it is used, and to what purpose
  • 15. Definitions that Describe Example: Aielron: A small, slender, hinged section on the outer portion of a wing, used to control an aircraft’s rolling and banking movements. Ailerons usually work in opposition: as the left aileron is deflected upward, the right is deflected downward, and vice versa.
  • 16. Definitions that Compare & Contrast  Give similarities or differences between subjects  Often compare or contrast something unfamiliar with something the audience knows  Provide a frame of reference by giving context
  • 17. Definitions that Compare & Contrast Example: Flash Drive: A small, lightweight, portable Universal Serial Bus (USB) device that allows users to store, carry, and transfer programs and files, much like the older 3.5-inch floppy disk. The flash drive, however, differs from the older floppy disks; it is much smaller (only 70 mm long, 30 mm wide, and about 11 mm in height) and more durable and contains no internal moving parts.
  • 18. Definitions that Classify  Categorize a term within a larger group in order to provide a context or association  Can be problematic because not everyone agrees on the meaning of particular categories
  • 19. Definitions that Classify Example: Someone writing a field guide to birds and animals in Texas could safely assume that many people would not know what an ocelot is. However, if the writer begins by defining an ocelot as a kind of wildcat, much of the mystery of the term disappears because most if not all readers can identify a wildcat.
  • 20. Definitions that Provide Examples  Provide a clear-cut and familiar example of the thing or concept being defined  Should use examples familiar to the audience  Frequently clarify abstract terms
  • 21. Definitions that Provide Examples Example: Sports car might be defined as vehicles with sleek body styles, superior acceleration, little cargo space, and so forth. While such a definition would be useful, any definition of sports car would benefit by providing specific examples: Chevrolet Corvette, Dodge Viper, or Porsche 911, for example.
  • 22. Definitions that Illustrate with Visuals  Give readers visual prompts to give clear and quick understanding  Benefit the reader by including a picture in addition to a written definition  Help explain concepts that one cannot actually see with the naked eye
  • 25. Ethics in Technical Definitions  Be aware of how definitions can potentially mislead, confuse, or cause danger or harm.  Ensure that readers have all the information necessary to use the product safely.  Rely on correct, unbiased information to help audiences make decisions.
  • 26. Ethics in Technical Definitions  Full Disclosure  Writers have not omitted any information that an audience needs to comprehend the term  Appropriate Style  Select a style that should be clearly grasped by the target audience
  • 27. Common Mistakes  Circular Definitions  Using the term in defining it  Synonyms  Using a similar term gives no useful information  Not User-Oriented  Failing to take the users’ or audiences’ knowledge, background, and needs into account
  • 29. Steps:  Identify the topic of your technical definition  Identify your audience  Identify purpose of definition (explanatory, operational, deliberative)  Select the type of combination of types of definitions that will work best for your topic, audience, and purpose.  Research your topic  Draft and Revise (pg 458)