SlideShare a Scribd company logo
1 of 55
Common Technical Writing Issues Tao Xie North Carolina State University Department of Computer Science June 2006 first version June 2010 last update http://www.csc.ncsu.edu/faculty/xie/ http://people.engr.ncsu.edu/txie/publications/writeissues.pdf More advice: http://www.csc.ncsu.edu/faculty/xie/advice/
Important goal ,[object Object],[object Object]
Top-Down Writing Style ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Avoid ambiguous words ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Avoid strong words ,[object Object],[object Object]
Avoid informal or offensive words ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Avoid complicated words ,[object Object]
Explicitly write out things  ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Which vs. That ,[object Object],[object Object],[object Object]
More on Which ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Figure 1, Table 1, Section 1,… ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Also, And, Further ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Repetition and Consistency is Good ,[object Object],[object Object],[object Object],[object Object],[object Object]
Dangling modifiers ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Fixing long sentences ,[object Object],[object Object]
Punctuation issues  ,[object Object],[object Object],[object Object],[object Object]
Citations ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Citations - II ,[object Object],[object Object],[object Object],[object Object]
Uncountable Words ,[object Object],[object Object],[object Object],[object Object],[object Object]
Abbreviation ,[object Object],[object Object],[object Object],[object Object],[object Object]
“ A” or “An”? ,[object Object],[object Object],[object Object]
Only ,[object Object],[object Object],[object Object],[object Object]
Will ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Avoid firstly, secondly, … ,[object Object],[object Object]
Avoid passive voice ,[object Object],[object Object]
Avoid passive voice - II ,[object Object]
Article usage ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Otherwise ,[object Object],[object Object],[object Object],[object Object]
No “can not”, avoid abbrev “n’t” ,[object Object],[object Object]
The authors ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Long subjects ,[object Object],[object Object]
Current vs. Existing ,[object Object],[object Object],[object Object]
Noun Stacking/Verbal ,[object Object],[object Object],[object Object],[object Object]
Redundancy ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
As below/as follows ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Using hyphen - ,[object Object],[object Object],[object Object],[object Object]
Confusing words ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Don’t over omit “,” or “that” ,[object Object],[object Object],[object Object],[object Object]
References ,[object Object],[object Object],[object Object]
Logic Flow ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Exercise ,[object Object],[object Object],[object Object],[object Object]
Writing Defect Recording Log
Example Defect Recording Log
Example Defect Recording Log
Paper Revision ,[object Object],[object Object],[object Object],[object Object],[object Object]
Paper Revision  cont. ,[object Object],[object Object],[object Object],[object Object]
Writing as communication media ,[object Object],[object Object]
Common Barriers for Beginners ,[object Object],[object Object],[object Object],[object Object],[object Object]
Write Early and Along the Way ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
More Tips on Advising ,[object Object]
Use LaTeX ,[object Object],[object Object],[object Object],[object Object],[object Object]
Excellent Online Dictionary ,[object Object],[object Object],[object Object]
Book Recommendations ,[object Object],[object Object],[object Object],[object Object],[object Object]
Book Recommendations  cont ,[object Object],[object Object],[object Object],[object Object]
More Resources ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

More Related Content

Viewers also liked (7)

Pita lovin business plan w5
Pita lovin business plan w5Pita lovin business plan w5
Pita lovin business plan w5
 
Dekoh last 79a
Dekoh last 79aDekoh last 79a
Dekoh last 79a
 
Parabolic motion
Parabolic motionParabolic motion
Parabolic motion
 
Dekoh last 79a
Dekoh last 79aDekoh last 79a
Dekoh last 79a
 
Jenzard Graphics
Jenzard GraphicsJenzard Graphics
Jenzard Graphics
 
Afa prof
Afa profAfa prof
Afa prof
 
Grunnendurlífgun og viðbrögð við bráðatilvikum
Grunnendurlífgun og viðbrögð við bráðatilvikumGrunnendurlífgun og viðbrögð við bráðatilvikum
Grunnendurlífgun og viðbrögð við bráðatilvikum
 

Similar to Writeissues

Technical writing tips
Technical writing tipsTechnical writing tips
Technical writing tips
Laura Albert
 
Ap Power Point Chpt3
Ap Power Point Chpt3Ap Power Point Chpt3
Ap Power Point Chpt3
dplunkett
 
Technical Writing For Consultants
Technical Writing For ConsultantsTechnical Writing For Consultants
Technical Writing For Consultants
rlucera
 

Similar to Writeissues (20)

Word_Embeddings.pptx
Word_Embeddings.pptxWord_Embeddings.pptx
Word_Embeddings.pptx
 
Technical writing tips
Technical writing tipsTechnical writing tips
Technical writing tips
 
Ap Power Point Chpt3
Ap Power Point Chpt3Ap Power Point Chpt3
Ap Power Point Chpt3
 
302 week7
302 week7302 week7
302 week7
 
Creativity vs Best Practices
Creativity vs Best PracticesCreativity vs Best Practices
Creativity vs Best Practices
 
War of the Machines: PVS-Studio vs. TensorFlow
War of the Machines: PVS-Studio vs. TensorFlowWar of the Machines: PVS-Studio vs. TensorFlow
War of the Machines: PVS-Studio vs. TensorFlow
 
Technical Writing For Consultants
Technical Writing For ConsultantsTechnical Writing For Consultants
Technical Writing For Consultants
 
Konstantin Knizhnik: static analysis, a view from aside
Konstantin Knizhnik: static analysis, a view from asideKonstantin Knizhnik: static analysis, a view from aside
Konstantin Knizhnik: static analysis, a view from aside
 
A Bonus to the "Three Interviews About Static Analyzers" Article, or Intervie...
A Bonus to the "Three Interviews About Static Analyzers" Article, or Intervie...A Bonus to the "Three Interviews About Static Analyzers" Article, or Intervie...
A Bonus to the "Three Interviews About Static Analyzers" Article, or Intervie...
 
Searching for bugs in Mono: there are hundreds of them!
Searching for bugs in Mono: there are hundreds of them!Searching for bugs in Mono: there are hundreds of them!
Searching for bugs in Mono: there are hundreds of them!
 
Brixton Library Technology Initiative Week1 Recap
Brixton Library Technology Initiative Week1 RecapBrixton Library Technology Initiative Week1 Recap
Brixton Library Technology Initiative Week1 Recap
 
Class 34
Class 34 Class 34
Class 34
 
Abstract
AbstractAbstract
Abstract
 
BDD Primer
BDD PrimerBDD Primer
BDD Primer
 
Getting your stuff published :-)
Getting your stuff published :-)Getting your stuff published :-)
Getting your stuff published :-)
 
2014 environmental engineeringlabmanual
2014 environmental engineeringlabmanual2014 environmental engineeringlabmanual
2014 environmental engineeringlabmanual
 
Spreadsheets for developers
Spreadsheets for developersSpreadsheets for developers
Spreadsheets for developers
 
Putting the science in computer science
Putting the science in computer sciencePutting the science in computer science
Putting the science in computer science
 
PVS-Studio Has Finally Got to Boost
PVS-Studio Has Finally Got to BoostPVS-Studio Has Finally Got to Boost
PVS-Studio Has Finally Got to Boost
 
The tyranny of averages
The tyranny of averagesThe tyranny of averages
The tyranny of averages
 

Recently uploaded

Seal of Good Local Governance (SGLG) 2024Final.pptx
Seal of Good Local Governance (SGLG) 2024Final.pptxSeal of Good Local Governance (SGLG) 2024Final.pptx
Seal of Good Local Governance (SGLG) 2024Final.pptx
negromaestrong
 
Gardella_Mateo_IntellectualProperty.pdf.
Gardella_Mateo_IntellectualProperty.pdf.Gardella_Mateo_IntellectualProperty.pdf.
Gardella_Mateo_IntellectualProperty.pdf.
MateoGardella
 
1029 - Danh muc Sach Giao Khoa 10 . pdf
1029 -  Danh muc Sach Giao Khoa 10 . pdf1029 -  Danh muc Sach Giao Khoa 10 . pdf
1029 - Danh muc Sach Giao Khoa 10 . pdf
QucHHunhnh
 
1029-Danh muc Sach Giao Khoa khoi 6.pdf
1029-Danh muc Sach Giao Khoa khoi  6.pdf1029-Danh muc Sach Giao Khoa khoi  6.pdf
1029-Danh muc Sach Giao Khoa khoi 6.pdf
QucHHunhnh
 

Recently uploaded (20)

Seal of Good Local Governance (SGLG) 2024Final.pptx
Seal of Good Local Governance (SGLG) 2024Final.pptxSeal of Good Local Governance (SGLG) 2024Final.pptx
Seal of Good Local Governance (SGLG) 2024Final.pptx
 
Unit-V; Pricing (Pharma Marketing Management).pptx
Unit-V; Pricing (Pharma Marketing Management).pptxUnit-V; Pricing (Pharma Marketing Management).pptx
Unit-V; Pricing (Pharma Marketing Management).pptx
 
Unit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptxUnit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptx
 
ICT Role in 21st Century Education & its Challenges.pptx
ICT Role in 21st Century Education & its Challenges.pptxICT Role in 21st Century Education & its Challenges.pptx
ICT Role in 21st Century Education & its Challenges.pptx
 
Accessible design: Minimum effort, maximum impact
Accessible design: Minimum effort, maximum impactAccessible design: Minimum effort, maximum impact
Accessible design: Minimum effort, maximum impact
 
Nutritional Needs Presentation - HLTH 104
Nutritional Needs Presentation - HLTH 104Nutritional Needs Presentation - HLTH 104
Nutritional Needs Presentation - HLTH 104
 
Gardella_Mateo_IntellectualProperty.pdf.
Gardella_Mateo_IntellectualProperty.pdf.Gardella_Mateo_IntellectualProperty.pdf.
Gardella_Mateo_IntellectualProperty.pdf.
 
1029 - Danh muc Sach Giao Khoa 10 . pdf
1029 -  Danh muc Sach Giao Khoa 10 . pdf1029 -  Danh muc Sach Giao Khoa 10 . pdf
1029 - Danh muc Sach Giao Khoa 10 . pdf
 
Holdier Curriculum Vitae (April 2024).pdf
Holdier Curriculum Vitae (April 2024).pdfHoldier Curriculum Vitae (April 2024).pdf
Holdier Curriculum Vitae (April 2024).pdf
 
Presentation by Andreas Schleicher Tackling the School Absenteeism Crisis 30 ...
Presentation by Andreas Schleicher Tackling the School Absenteeism Crisis 30 ...Presentation by Andreas Schleicher Tackling the School Absenteeism Crisis 30 ...
Presentation by Andreas Schleicher Tackling the School Absenteeism Crisis 30 ...
 
microwave assisted reaction. General introduction
microwave assisted reaction. General introductionmicrowave assisted reaction. General introduction
microwave assisted reaction. General introduction
 
Ecological Succession. ( ECOSYSTEM, B. Pharmacy, 1st Year, Sem-II, Environmen...
Ecological Succession. ( ECOSYSTEM, B. Pharmacy, 1st Year, Sem-II, Environmen...Ecological Succession. ( ECOSYSTEM, B. Pharmacy, 1st Year, Sem-II, Environmen...
Ecological Succession. ( ECOSYSTEM, B. Pharmacy, 1st Year, Sem-II, Environmen...
 
Código Creativo y Arte de Software | Unidad 1
Código Creativo y Arte de Software | Unidad 1Código Creativo y Arte de Software | Unidad 1
Código Creativo y Arte de Software | Unidad 1
 
fourth grading exam for kindergarten in writing
fourth grading exam for kindergarten in writingfourth grading exam for kindergarten in writing
fourth grading exam for kindergarten in writing
 
1029-Danh muc Sach Giao Khoa khoi 6.pdf
1029-Danh muc Sach Giao Khoa khoi  6.pdf1029-Danh muc Sach Giao Khoa khoi  6.pdf
1029-Danh muc Sach Giao Khoa khoi 6.pdf
 
Unit-IV- Pharma. Marketing Channels.pptx
Unit-IV- Pharma. Marketing Channels.pptxUnit-IV- Pharma. Marketing Channels.pptx
Unit-IV- Pharma. Marketing Channels.pptx
 
Mehran University Newsletter Vol-X, Issue-I, 2024
Mehran University Newsletter Vol-X, Issue-I, 2024Mehran University Newsletter Vol-X, Issue-I, 2024
Mehran University Newsletter Vol-X, Issue-I, 2024
 
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptx
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptxSOCIAL AND HISTORICAL CONTEXT - LFTVD.pptx
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptx
 
Advanced Views - Calendar View in Odoo 17
Advanced Views - Calendar View in Odoo 17Advanced Views - Calendar View in Odoo 17
Advanced Views - Calendar View in Odoo 17
 
Advance Mobile Application Development class 07
Advance Mobile Application Development class 07Advance Mobile Application Development class 07
Advance Mobile Application Development class 07
 

Writeissues

  • 1. Common Technical Writing Issues Tao Xie North Carolina State University Department of Computer Science June 2006 first version June 2010 last update http://www.csc.ncsu.edu/faculty/xie/ http://people.engr.ncsu.edu/txie/publications/writeissues.pdf More advice: http://www.csc.ncsu.edu/faculty/xie/advice/
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.
  • 36.
  • 37.
  • 38.
  • 39.
  • 40.
  • 41.
  • 45.
  • 46.
  • 47.
  • 48.
  • 49.
  • 50.
  • 51.
  • 52.
  • 53.
  • 54.
  • 55.