SlideShare a Scribd company logo
1 of 17
Chapter 6
An Overview of the
Technical Writing Process
Technical Communication,
13th Edition
John M. Lannon
Laura J. Gurak

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Learning Objectives
 Identify unique aspects of the technical

writing process
 Appreciate the role of critical thinking during
that process
 Follow one working writer through an
everyday writing situation
 Observe the steps in planning, drafting, and
revising a document

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Learning Objectives (continued)
 Understand why proofreading is an important

final step
 Appreciate the advantages and drawbacks of
digital writing tools

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
The Technical Writing Process
Although the writing process (researching,
planning, drafting, and revising) is similar
across all disciplines, the process for technical
writing differs from the process for essay writing
in some ways. For example:
Research often involves discussions with technical

experts.
Analysis of audience needs and expectations is
critical.
Complex organizational settings and “office politics”
play an important role.
Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
The Technical Writing Process
(continued)
 Colleagues frequently collaborate in preparing a





document.
Many workplace documents are carefully reviewed
before being released.
Proper format (letter, memo, report, brochure, and so
on) for a document is essential.
Proper distribution medium (hard copy or digital) is
essential.
Deadlines often limit the amount of time that can be
spent preparing a document.

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
The Technical Writing Process
(continued)
An illustration of the technical writing process:

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Questions to Consider as
You Work with the Ideas and
Information
 Have I defined the issue accurately?
 Is the information I’ve gathered complete, accurate,







reliable, and unbiased?
Can it be verified?
How much of it is useful?
Is a balance of viewpoints represented?
What do these facts mean?
What conclusions seem to emerge?
Are other interpretations possible?
Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Questions to Consider as
You Work with the Ideas and
Information (continued)
 What, if anything, should be done?
 What are the risks and benefits?
 What other consequences might this have?
 Should I reconsider?

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Questions to Consider as
You Plan the Document
 What do I want it to accomplish?
 Who is my audience, and why will they use this







document?
What do they need to know?
What are the “political realities” (feelings, egos,
cultural differences, and so on)?
How will I organize?
What format and visuals should I use?
Whose help will I need?
When is it due?
Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Questions to Consider as
You Draft the Document
 How do I begin, and what comes next?
 How much is enough?
 What can I leave out?
 Am I forgetting anything?
 How will I end?
 Who needs to review my drafts?

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Questions to Consider
as You Evaluate and Revise
the Document
 Does this draft do what I want it to do?
 Is the content useful?
 Is the organization sensible?
 Is the style readable?
 Is everything easy to find?
 Is the format appealing?
 Is the medium appropriate?
 Is everything accurate, complete, appropriate, and

correct?
Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Questions to Consider
as You Evaluate and Revise
the Document (continued)
 Is the information honest and fair?
 Who needs to review and approve the final version?
 Does it advance my organization’s goals?
 Does it advance my audience’s goals?

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Make Proofreading
Your Final Step
Basic errors distract the reader and make the
writer look bad. Proofreading for the following:
Sentence errors
Punctuation errors
Usage errors
Mechanical errors
Format errors
Typographical errors

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Guidelines for Proofreading
Keep in mind the following guidelines when
proofreading a document:
Save it for the final draft
Take a break before proofreading your final document
Work from hard copy
Keep it slow
Be especially alert for problem areas in your writing
Proofread more than once
Never rely only on the computer

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Digital Technology and the
Writing Process
 A variety of digital tools and programs exist

that provide support for the technical writing
process.
 Consider using such options as brainstorming
and storyboarding software, wikis, tracking
systems, social media for research,
flowcharting and mapping software, and
more.

Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Review Questions
1. What are the four stages of the writing
process?
2. What are five questions to ask when working
with ideas and information?
3. What are five questions to ask when planning
the document?
4. What are five questions to ask when drafting
the document?
5. What are five questions to ask when
evaluating and revising the document?
Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
Review Questions (continued)
6. Why is proofreading important as a final
step?
7. What are six types of errors to look for when
proofreading?
8. When should you proofread?
9. How many times should you proofread?
10. What are three digital technologies that
enhance the writing process?
Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.

More Related Content

What's hot

شرح برنامج الورود
شرح برنامج الورودشرح برنامج الورود
شرح برنامج الورود
Hanaa Ahmed
 
English For Specific Purposes
English For Specific PurposesEnglish For Specific Purposes
English For Specific Purposes
guest7f1ad678
 
____ ________ ___ ___ ________ __________ _ __________
  ____ ________ ___ ___ ________ __________ _ __________  ____ ________ ___ ___ ________ __________ _ __________
____ ________ ___ ___ ________ __________ _ __________
cfie2012
 
Planning lessons using the internet, Internet-based lessons
Planning lessons using the internet, Internet-based lessonsPlanning lessons using the internet, Internet-based lessons
Planning lessons using the internet, Internet-based lessons
Recep Aytar
 
Technology and second language acquisition
Technology and second language acquisitionTechnology and second language acquisition
Technology and second language acquisition
Milton Gomez
 

What's hot (20)

مهارات متقدمة في معالج النصوص word 2010
مهارات متقدمة في معالج النصوص word 2010مهارات متقدمة في معالج النصوص word 2010
مهارات متقدمة في معالج النصوص word 2010
 
Sustainable Manufacturing (MIT 2.008x Lecture Slides)
Sustainable Manufacturing (MIT 2.008x Lecture Slides)Sustainable Manufacturing (MIT 2.008x Lecture Slides)
Sustainable Manufacturing (MIT 2.008x Lecture Slides)
 
كراسة النحو الشاملة للصف الثانى الإعدادى الفصل الدراسى الأول 2017 أ.أمنية وجدى
كراسة النحو الشاملة للصف الثانى الإعدادى الفصل الدراسى الأول 2017 أ.أمنية وجدىكراسة النحو الشاملة للصف الثانى الإعدادى الفصل الدراسى الأول 2017 أ.أمنية وجدى
كراسة النحو الشاملة للصف الثانى الإعدادى الفصل الدراسى الأول 2017 أ.أمنية وجدى
 
الخط العربي
الخط العربيالخط العربي
الخط العربي
 
The Mental Process of Speech Comprehension
The Mental Process of Speech ComprehensionThe Mental Process of Speech Comprehension
The Mental Process of Speech Comprehension
 
شرح برنامج الورود
شرح برنامج الورودشرح برنامج الورود
شرح برنامج الورود
 
الوسائط الرقمية وتطبيقاتها في المكتبات ومؤسسات المعلومات
الوسائط الرقمية وتطبيقاتها في المكتبات ومؤسسات المعلوماتالوسائط الرقمية وتطبيقاتها في المكتبات ومؤسسات المعلومات
الوسائط الرقمية وتطبيقاتها في المكتبات ومؤسسات المعلومات
 
English For Specific Purposes
English For Specific PurposesEnglish For Specific Purposes
English For Specific Purposes
 
ESP Materiasl Evaluation
ESP Materiasl EvaluationESP Materiasl Evaluation
ESP Materiasl Evaluation
 
Approaches to Language Testing
Approaches to Language TestingApproaches to Language Testing
Approaches to Language Testing
 
Course Outline Technical English 2 31534
Course Outline Technical English 2 31534Course Outline Technical English 2 31534
Course Outline Technical English 2 31534
 
التاريخ وأصل اللغة العربية
التاريخ وأصل اللغة العربيةالتاريخ وأصل اللغة العربية
التاريخ وأصل اللغة العربية
 
____ ________ ___ ___ ________ __________ _ __________
  ____ ________ ___ ___ ________ __________ _ __________  ____ ________ ___ ___ ________ __________ _ __________
____ ________ ___ ___ ________ __________ _ __________
 
دفتر تحضير حاسب آلى ترم أول أولى ثانوى2015
دفتر تحضير حاسب آلى ترم أول أولى ثانوى2015 دفتر تحضير حاسب آلى ترم أول أولى ثانوى2015
دفتر تحضير حاسب آلى ترم أول أولى ثانوى2015
 
English for Specific Purposes (ESP)
English for Specific Purposes (ESP)English for Specific Purposes (ESP)
English for Specific Purposes (ESP)
 
Delta 3 curriculum & syllabus design and course planning
Delta 3   curriculum & syllabus design and course planningDelta 3   curriculum & syllabus design and course planning
Delta 3 curriculum & syllabus design and course planning
 
المحاضرة الأولى في مصادر المعلومات
المحاضرة الأولى في مصادر المعلوماتالمحاضرة الأولى في مصادر المعلومات
المحاضرة الأولى في مصادر المعلومات
 
الجملة الاسمية
الجملة الاسميةالجملة الاسمية
الجملة الاسمية
 
Planning lessons using the internet, Internet-based lessons
Planning lessons using the internet, Internet-based lessonsPlanning lessons using the internet, Internet-based lessons
Planning lessons using the internet, Internet-based lessons
 
Technology and second language acquisition
Technology and second language acquisitionTechnology and second language acquisition
Technology and second language acquisition
 

Viewers also liked

Thinking Critically about the Research Process
Thinking Critically about the Research ProcessThinking Critically about the Research Process
Thinking Critically about the Research Process
joancrittenden
 
Importance of technical communication
Importance of technical communicationImportance of technical communication
Importance of technical communication
srbhgrg
 
General communication skills
General communication skillsGeneral communication skills
General communication skills
trogdorshot
 
Technical writing nature and outputs
Technical writing nature and outputsTechnical writing nature and outputs
Technical writing nature and outputs
Sowie Althea
 

Viewers also liked (20)

Chapter 1: Introduction to Technical Communications
Chapter 1: Introduction to Technical CommunicationsChapter 1: Introduction to Technical Communications
Chapter 1: Introduction to Technical Communications
 
Chapter 6: An Overview of the Technical Writing Process
Chapter 6: An Overview of the Technical Writing ProcessChapter 6: An Overview of the Technical Writing Process
Chapter 6: An Overview of the Technical Writing Process
 
Chapter 4: Weighing the Ethical Issues
Chapter 4: Weighing the Ethical IssuesChapter 4: Weighing the Ethical Issues
Chapter 4: Weighing the Ethical Issues
 
Chapter 2: Meeting the Needs of Specific Audiences
Chapter 2: Meeting the Needs of Specific AudiencesChapter 2: Meeting the Needs of Specific Audiences
Chapter 2: Meeting the Needs of Specific Audiences
 
Chapter 3: Persuading Your Audience
Chapter 3:  Persuading Your AudienceChapter 3:  Persuading Your Audience
Chapter 3: Persuading Your Audience
 
Thinking Critically about the Research Process
Thinking Critically about the Research ProcessThinking Critically about the Research Process
Thinking Critically about the Research Process
 
Technical Communication
Technical CommunicationTechnical Communication
Technical Communication
 
Importance of technical communication
Importance of technical communicationImportance of technical communication
Importance of technical communication
 
Self reflection technical writing
Self reflection technical writingSelf reflection technical writing
Self reflection technical writing
 
Writing Technical Paper
Writing Technical PaperWriting Technical Paper
Writing Technical Paper
 
Abstract writing
Abstract writingAbstract writing
Abstract writing
 
General communication skills
General communication skillsGeneral communication skills
General communication skills
 
Writing an abstract
Writing an abstractWriting an abstract
Writing an abstract
 
Technical writing
Technical writingTechnical writing
Technical writing
 
Difference between General communication and Technical Communication
Difference between General communication and Technical CommunicationDifference between General communication and Technical Communication
Difference between General communication and Technical Communication
 
Technical writing nature and outputs
Technical writing nature and outputsTechnical writing nature and outputs
Technical writing nature and outputs
 
Technical writing
Technical writingTechnical writing
Technical writing
 
Technical writing: Some guidelines
Technical writing: Some guidelinesTechnical writing: Some guidelines
Technical writing: Some guidelines
 
Best Practices for Documenting Technical Procedures
Best Practices for Documenting Technical ProceduresBest Practices for Documenting Technical Procedures
Best Practices for Documenting Technical Procedures
 
Guidelines for technical writing documents
Guidelines for technical writing documentsGuidelines for technical writing documents
Guidelines for technical writing documents
 

Similar to Chapter 5: Teamwork and Global Considerations

Copyright © 2012 Pearson Education, Inc..docx
Copyright © 2012 Pearson Education, Inc..docxCopyright © 2012 Pearson Education, Inc..docx
Copyright © 2012 Pearson Education, Inc..docx
vanesaburnand
 
CHAPTER 1 technical writing for business students
CHAPTER 1 technical writing for business studentsCHAPTER 1 technical writing for business students
CHAPTER 1 technical writing for business students
madelguarin4
 
Chapter 2 Technical Writing in Business on AUDIENCES
Chapter 2 Technical Writing in Business on AUDIENCESChapter 2 Technical Writing in Business on AUDIENCES
Chapter 2 Technical Writing in Business on AUDIENCES
madelguarin4
 
For this two-part assessment, you will create an Excel spreadsheet o.docx
For this two-part assessment, you will create an Excel spreadsheet o.docxFor this two-part assessment, you will create an Excel spreadsheet o.docx
For this two-part assessment, you will create an Excel spreadsheet o.docx
mckellarhastings
 
HTY 110HA Module 8 Presentation Project Instructions
HTY 110HA  Module 8 Presentation Project Instructions HTY 110HA  Module 8 Presentation Project Instructions
HTY 110HA Module 8 Presentation Project Instructions
NarcisaBrandenburg70
 
Succeeding With SharePoint In Seven Steps - Share Atlanta
Succeeding With SharePoint In Seven Steps - Share AtlantaSucceeding With SharePoint In Seven Steps - Share Atlanta
Succeeding With SharePoint In Seven Steps - Share Atlanta
Richard Harbridge
 
Case StudyREQUIRED WRITTEN PROJECTCase Study 7.1 The Ford Pi
Case StudyREQUIRED WRITTEN PROJECTCase Study 7.1 The Ford PiCase StudyREQUIRED WRITTEN PROJECTCase Study 7.1 The Ford Pi
Case StudyREQUIRED WRITTEN PROJECTCase Study 7.1 The Ford Pi
MaximaSheffield592
 
Personas In Documentation
Personas In DocumentationPersonas In Documentation
Personas In Documentation
Arun J Martin
 
SharePoint Success In Seven Steps - Microsoft SPC12
SharePoint Success In Seven Steps - Microsoft SPC12SharePoint Success In Seven Steps - Microsoft SPC12
SharePoint Success In Seven Steps - Microsoft SPC12
Richard Harbridge
 
Title of PresentationStudent’s nameFeel free to adjust the c.docx
Title of PresentationStudent’s nameFeel free to adjust the c.docxTitle of PresentationStudent’s nameFeel free to adjust the c.docx
Title of PresentationStudent’s nameFeel free to adjust the c.docx
herthalearmont
 
Smithgirard(2)
Smithgirard(2)Smithgirard(2)
Smithgirard(2)
dmloch
 

Similar to Chapter 5: Teamwork and Global Considerations (20)

Copyright © 2012 Pearson Education, Inc..docx
Copyright © 2012 Pearson Education, Inc..docxCopyright © 2012 Pearson Education, Inc..docx
Copyright © 2012 Pearson Education, Inc..docx
 
CHAPTER 1 technical writing for business students
CHAPTER 1 technical writing for business studentsCHAPTER 1 technical writing for business students
CHAPTER 1 technical writing for business students
 
Chapter 2 Technical Writing in Business on AUDIENCES
Chapter 2 Technical Writing in Business on AUDIENCESChapter 2 Technical Writing in Business on AUDIENCES
Chapter 2 Technical Writing in Business on AUDIENCES
 
For this two-part assessment, you will create an Excel spreadsheet o.docx
For this two-part assessment, you will create an Excel spreadsheet o.docxFor this two-part assessment, you will create an Excel spreadsheet o.docx
For this two-part assessment, you will create an Excel spreadsheet o.docx
 
SharePoint document collaboration 2012
SharePoint document collaboration 2012SharePoint document collaboration 2012
SharePoint document collaboration 2012
 
HTY 110HA Module 8 Presentation Project Instructions
HTY 110HA  Module 8 Presentation Project Instructions HTY 110HA  Module 8 Presentation Project Instructions
HTY 110HA Module 8 Presentation Project Instructions
 
Designing Job Aids
Designing Job AidsDesigning Job Aids
Designing Job Aids
 
Succeeding With SharePoint In Seven Steps - Share Atlanta
Succeeding With SharePoint In Seven Steps - Share AtlantaSucceeding With SharePoint In Seven Steps - Share Atlanta
Succeeding With SharePoint In Seven Steps - Share Atlanta
 
Case StudyREQUIRED WRITTEN PROJECTCase Study 7.1 The Ford Pi
Case StudyREQUIRED WRITTEN PROJECTCase Study 7.1 The Ford PiCase StudyREQUIRED WRITTEN PROJECTCase Study 7.1 The Ford Pi
Case StudyREQUIRED WRITTEN PROJECTCase Study 7.1 The Ford Pi
 
E Learning Case Study
E Learning Case StudyE Learning Case Study
E Learning Case Study
 
Veda Semantics - introduction document
Veda Semantics - introduction documentVeda Semantics - introduction document
Veda Semantics - introduction document
 
2011 Distinguished Evaluator: The Health Foundation of Greater Cincinnati
2011 Distinguished Evaluator: The Health Foundation of Greater Cincinnati2011 Distinguished Evaluator: The Health Foundation of Greater Cincinnati
2011 Distinguished Evaluator: The Health Foundation of Greater Cincinnati
 
Personas In Documentation
Personas In DocumentationPersonas In Documentation
Personas In Documentation
 
SharePoint Success In Seven Steps - Microsoft SPC12
SharePoint Success In Seven Steps - Microsoft SPC12SharePoint Success In Seven Steps - Microsoft SPC12
SharePoint Success In Seven Steps - Microsoft SPC12
 
Create the Foundation of an App - UX Wannabe 5
Create the Foundation of an App - UX Wannabe 5Create the Foundation of an App - UX Wannabe 5
Create the Foundation of an App - UX Wannabe 5
 
Successful Single-Source Content Development
Successful Single-Source Content Development Successful Single-Source Content Development
Successful Single-Source Content Development
 
Title of PresentationStudent’s nameFeel free to adjust the c.docx
Title of PresentationStudent’s nameFeel free to adjust the c.docxTitle of PresentationStudent’s nameFeel free to adjust the c.docx
Title of PresentationStudent’s nameFeel free to adjust the c.docx
 
ION
ION ION
ION
 
Scale2014
Scale2014Scale2014
Scale2014
 
Smithgirard(2)
Smithgirard(2)Smithgirard(2)
Smithgirard(2)
 

Recently uploaded

Spellings Wk 4 and Wk 5 for Grade 4 at CAPS
Spellings Wk 4 and Wk 5 for Grade 4 at CAPSSpellings Wk 4 and Wk 5 for Grade 4 at CAPS
Spellings Wk 4 and Wk 5 for Grade 4 at CAPS
AnaAcapella
 

Recently uploaded (20)

Spellings Wk 4 and Wk 5 for Grade 4 at CAPS
Spellings Wk 4 and Wk 5 for Grade 4 at CAPSSpellings Wk 4 and Wk 5 for Grade 4 at CAPS
Spellings Wk 4 and Wk 5 for Grade 4 at CAPS
 
Jamworks pilot and AI at Jisc (20/03/2024)
Jamworks pilot and AI at Jisc (20/03/2024)Jamworks pilot and AI at Jisc (20/03/2024)
Jamworks pilot and AI at Jisc (20/03/2024)
 
TỔNG ÔN TẬP THI VÀO LỚP 10 MÔN TIẾNG ANH NĂM HỌC 2023 - 2024 CÓ ĐÁP ÁN (NGỮ Â...
TỔNG ÔN TẬP THI VÀO LỚP 10 MÔN TIẾNG ANH NĂM HỌC 2023 - 2024 CÓ ĐÁP ÁN (NGỮ Â...TỔNG ÔN TẬP THI VÀO LỚP 10 MÔN TIẾNG ANH NĂM HỌC 2023 - 2024 CÓ ĐÁP ÁN (NGỮ Â...
TỔNG ÔN TẬP THI VÀO LỚP 10 MÔN TIẾNG ANH NĂM HỌC 2023 - 2024 CÓ ĐÁP ÁN (NGỮ Â...
 
Unit 3 Emotional Intelligence and Spiritual Intelligence.pdf
Unit 3 Emotional Intelligence and Spiritual Intelligence.pdfUnit 3 Emotional Intelligence and Spiritual Intelligence.pdf
Unit 3 Emotional Intelligence and Spiritual Intelligence.pdf
 
Tatlong Kwento ni Lola basyang-1.pdf arts
Tatlong Kwento ni Lola basyang-1.pdf artsTatlong Kwento ni Lola basyang-1.pdf arts
Tatlong Kwento ni Lola basyang-1.pdf arts
 
How to Manage Call for Tendor in Odoo 17
How to Manage Call for Tendor in Odoo 17How to Manage Call for Tendor in Odoo 17
How to Manage Call for Tendor in Odoo 17
 
How to setup Pycharm environment for Odoo 17.pptx
How to setup Pycharm environment for Odoo 17.pptxHow to setup Pycharm environment for Odoo 17.pptx
How to setup Pycharm environment for Odoo 17.pptx
 
Details on CBSE Compartment Exam.pptx1111
Details on CBSE Compartment Exam.pptx1111Details on CBSE Compartment Exam.pptx1111
Details on CBSE Compartment Exam.pptx1111
 
FSB Advising Checklist - Orientation 2024
FSB Advising Checklist - Orientation 2024FSB Advising Checklist - Orientation 2024
FSB Advising Checklist - Orientation 2024
 
OSCM Unit 2_Operations Processes & Systems
OSCM Unit 2_Operations Processes & SystemsOSCM Unit 2_Operations Processes & Systems
OSCM Unit 2_Operations Processes & Systems
 
On National Teacher Day, meet the 2024-25 Kenan Fellows
On National Teacher Day, meet the 2024-25 Kenan FellowsOn National Teacher Day, meet the 2024-25 Kenan Fellows
On National Teacher Day, meet the 2024-25 Kenan Fellows
 
Exploring_the_Narrative_Style_of_Amitav_Ghoshs_Gun_Island.pptx
Exploring_the_Narrative_Style_of_Amitav_Ghoshs_Gun_Island.pptxExploring_the_Narrative_Style_of_Amitav_Ghoshs_Gun_Island.pptx
Exploring_the_Narrative_Style_of_Amitav_Ghoshs_Gun_Island.pptx
 
Economic Importance Of Fungi In Food Additives
Economic Importance Of Fungi In Food AdditivesEconomic Importance Of Fungi In Food Additives
Economic Importance Of Fungi In Food Additives
 
How to Create and Manage Wizard in Odoo 17
How to Create and Manage Wizard in Odoo 17How to Create and Manage Wizard in Odoo 17
How to Create and Manage Wizard in Odoo 17
 
VAMOS CUIDAR DO NOSSO PLANETA! .
VAMOS CUIDAR DO NOSSO PLANETA!                    .VAMOS CUIDAR DO NOSSO PLANETA!                    .
VAMOS CUIDAR DO NOSSO PLANETA! .
 
FICTIONAL SALESMAN/SALESMAN SNSW 2024.pdf
FICTIONAL SALESMAN/SALESMAN SNSW 2024.pdfFICTIONAL SALESMAN/SALESMAN SNSW 2024.pdf
FICTIONAL SALESMAN/SALESMAN SNSW 2024.pdf
 
dusjagr & nano talk on open tools for agriculture research and learning
dusjagr & nano talk on open tools for agriculture research and learningdusjagr & nano talk on open tools for agriculture research and learning
dusjagr & nano talk on open tools for agriculture research and learning
 
On_Translating_a_Tamil_Poem_by_A_K_Ramanujan.pptx
On_Translating_a_Tamil_Poem_by_A_K_Ramanujan.pptxOn_Translating_a_Tamil_Poem_by_A_K_Ramanujan.pptx
On_Translating_a_Tamil_Poem_by_A_K_Ramanujan.pptx
 
Towards a code of practice for AI in AT.pptx
Towards a code of practice for AI in AT.pptxTowards a code of practice for AI in AT.pptx
Towards a code of practice for AI in AT.pptx
 
NO1 Top Black Magic Specialist In Lahore Black magic In Pakistan Kala Ilam Ex...
NO1 Top Black Magic Specialist In Lahore Black magic In Pakistan Kala Ilam Ex...NO1 Top Black Magic Specialist In Lahore Black magic In Pakistan Kala Ilam Ex...
NO1 Top Black Magic Specialist In Lahore Black magic In Pakistan Kala Ilam Ex...
 

Chapter 5: Teamwork and Global Considerations

  • 1. Chapter 6 An Overview of the Technical Writing Process Technical Communication, 13th Edition John M. Lannon Laura J. Gurak Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 2. Learning Objectives  Identify unique aspects of the technical writing process  Appreciate the role of critical thinking during that process  Follow one working writer through an everyday writing situation  Observe the steps in planning, drafting, and revising a document Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 3. Learning Objectives (continued)  Understand why proofreading is an important final step  Appreciate the advantages and drawbacks of digital writing tools Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 4. The Technical Writing Process Although the writing process (researching, planning, drafting, and revising) is similar across all disciplines, the process for technical writing differs from the process for essay writing in some ways. For example: Research often involves discussions with technical experts. Analysis of audience needs and expectations is critical. Complex organizational settings and “office politics” play an important role. Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 5. The Technical Writing Process (continued)  Colleagues frequently collaborate in preparing a     document. Many workplace documents are carefully reviewed before being released. Proper format (letter, memo, report, brochure, and so on) for a document is essential. Proper distribution medium (hard copy or digital) is essential. Deadlines often limit the amount of time that can be spent preparing a document. Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 6. The Technical Writing Process (continued) An illustration of the technical writing process: Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 7. Questions to Consider as You Work with the Ideas and Information  Have I defined the issue accurately?  Is the information I’ve gathered complete, accurate,       reliable, and unbiased? Can it be verified? How much of it is useful? Is a balance of viewpoints represented? What do these facts mean? What conclusions seem to emerge? Are other interpretations possible? Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 8. Questions to Consider as You Work with the Ideas and Information (continued)  What, if anything, should be done?  What are the risks and benefits?  What other consequences might this have?  Should I reconsider? Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 9. Questions to Consider as You Plan the Document  What do I want it to accomplish?  Who is my audience, and why will they use this       document? What do they need to know? What are the “political realities” (feelings, egos, cultural differences, and so on)? How will I organize? What format and visuals should I use? Whose help will I need? When is it due? Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 10. Questions to Consider as You Draft the Document  How do I begin, and what comes next?  How much is enough?  What can I leave out?  Am I forgetting anything?  How will I end?  Who needs to review my drafts? Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 11. Questions to Consider as You Evaluate and Revise the Document  Does this draft do what I want it to do?  Is the content useful?  Is the organization sensible?  Is the style readable?  Is everything easy to find?  Is the format appealing?  Is the medium appropriate?  Is everything accurate, complete, appropriate, and correct? Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 12. Questions to Consider as You Evaluate and Revise the Document (continued)  Is the information honest and fair?  Who needs to review and approve the final version?  Does it advance my organization’s goals?  Does it advance my audience’s goals? Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 13. Make Proofreading Your Final Step Basic errors distract the reader and make the writer look bad. Proofreading for the following: Sentence errors Punctuation errors Usage errors Mechanical errors Format errors Typographical errors Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 14. Guidelines for Proofreading Keep in mind the following guidelines when proofreading a document: Save it for the final draft Take a break before proofreading your final document Work from hard copy Keep it slow Be especially alert for problem areas in your writing Proofread more than once Never rely only on the computer Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 15. Digital Technology and the Writing Process  A variety of digital tools and programs exist that provide support for the technical writing process.  Consider using such options as brainstorming and storyboarding software, wikis, tracking systems, social media for research, flowcharting and mapping software, and more. Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 16. Review Questions 1. What are the four stages of the writing process? 2. What are five questions to ask when working with ideas and information? 3. What are five questions to ask when planning the document? 4. What are five questions to ask when drafting the document? 5. What are five questions to ask when evaluating and revising the document? Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.
  • 17. Review Questions (continued) 6. Why is proofreading important as a final step? 7. What are six types of errors to look for when proofreading? 8. When should you proofread? 9. How many times should you proofread? 10. What are three digital technologies that enhance the writing process? Copyright © 2014, 2011, 2008 by Pearson Education, Inc. All rights reserved.

Editor's Notes

  1. Chapter 6 describes the process of creating technical documents. The reality of communicating in a workplace in which the rhetorical complexities transcend linear notions of merely “transmitting” information is illustrated by the case of Glenn Tarullo. The intent here is not to overwhelm students, but to help them define the kinds of problems they need to solve, the range of decisions they need to make, and the types of strategies they might employ for effective decision making.
  2. Answers 1. Researching, planning, drafting, and revising. 2. Any of the following: Have I defined the issue accurately? Is the information I’ve gathered complete, accurate, reliable, and unbiased? Can it be verified? How much of it is useful? Is a balance of viewpoints represented? What do these facts mean? What conclusions seem to emerge? Are other interpretations possible? What, if anything, should be done? What are the risks and benefits? What other consequences might this have? Should I reconsider? 3. Any of the following: What do I want it to accomplish? Who is my audience, and why will they use this document? What do they need to know? What are the "political realities" (feelings, egos, cultural differences, and so on)? How will I organize? What format and visuals should I use? Whose help will I need? When is it due? 4. Any of the following: How do I begin, and what comes next? How much is enough? What can I leave out? Am I forgetting anything? How will I end? Who needs to review my drafts? 5. Any of the following: Does this draft do what I want it to do? Is the content useful? Is the organization sensible? Is the style readable? Is everything easy to find? Is the format appealing? Is the medium appropriate? Is everything accurate, complete, appropriate, and correct? Is the information honest and fair? Who needs to review and approve the final version? Does it advance my organization's goals? Does it advance my audience's goals?
  3. Answers (continued) 6. If you don’t correct basic errors, you will distract the reader and make yourself look bad. 7. Sentence errors, punctuation errors, usage errors, mechanical errors, format errors, and typographical errors. 8. When you are working on your final draft. 9. More than once. 10. Any of the following: brainstorming and storyboarding software, wikis, tracking systems, social media, flowcharting and mapping software.