SlideShare a Scribd company logo
1 of 9
CREATING TECHNICAL
DOCUMENT
Technical writing
TECHNICAL DOCUMENT
Technical writing requires objective analysis and clear presentation.
It is imperative to act professionally and ethically in all dealings with specific
audience, the public and government agencies.
Steps for successful writing are:
• Preparation
• Research
• Organization
• Writing a draft
• Revision
WRITING TECHNICAL DOCUMENT
• The goal of technical writing is to enable readers to use a technology or understand
a process or concept.
• Because the subject matter is more important than the writer’s voice, technical
writing style uses an objective, not a subjective, tone.
WRITING TECHNICAL DOCUMENT
• The writing style is direct and utilitarian, emphasizing exactness and clarity rather
than elegance or allusiveness.
• A technical writer uses figurative language only when a figure of speech would
facilitate understanding.
WRITING TECHNICAL DOCUMENT
• Technical writing is often—but not always—aimed at readers who are not experts in
the subject, such as consumers or employees learning to operate unfamiliar
equipment.
• Because such audiences are inexperienced and the procedures described may
involve hazardous material or equipment, clarity becomes an ethical as well as a
stylistic concern.
WRITING TECHNICAL DOCUMENT
• Technical writing style may use a technical vocabulary appropriate for the reader.
• Good technical writing also avoids overusing the passive voice.
ETHICAL PRINCIPLES
• Avoid language that attempts to evade responsibility
• Avoid language that could possibly mislead readers
• Do not de-emphasize or suppress important information
• Do not emphasize misleading or incorrect information
• Treat others fairly and respectfully
STYLE & USAGE
• Elements of style-
• Present Tense, active voice
• Simple sentences
• Gender neutrality
• Abbreviations and acronyms
• Lists
• Sidebars
• Figures and Tables
• Cross-references
• Footnotes and endnotes
• Redundancy
• Final edit
REFERENCE
Alred, Brusaw & Oliu. (2011). The Handbook of Technical Writing, Ninth Edition

More Related Content

What's hot (20)

Technical report writing
Technical report writingTechnical report writing
Technical report writing
 
Genn 001 Lec 9
Genn 001 Lec 9Genn 001 Lec 9
Genn 001 Lec 9
 
Best practices in Technical Writing
Best practices in Technical WritingBest practices in Technical Writing
Best practices in Technical Writing
 
technical writing styles
technical writing stylestechnical writing styles
technical writing styles
 
Technical report-writing-1
Technical report-writing-1Technical report-writing-1
Technical report-writing-1
 
Unit 5, BASICS OF TECHINICAL ENGLISH CODE 6465
Unit  5, BASICS OF TECHINICAL ENGLISH CODE 6465Unit  5, BASICS OF TECHINICAL ENGLISH CODE 6465
Unit 5, BASICS OF TECHINICAL ENGLISH CODE 6465
 
Technical report writing
Technical report writingTechnical report writing
Technical report writing
 
Technical Writing - Focus on White Papers
Technical Writing - Focus on White PapersTechnical Writing - Focus on White Papers
Technical Writing - Focus on White Papers
 
Report writing and its elements
Report writing and its elementsReport writing and its elements
Report writing and its elements
 
Writing reports (Case Report)
Writing reports (Case Report)Writing reports (Case Report)
Writing reports (Case Report)
 
Technical writing
Technical writingTechnical writing
Technical writing
 
Report writing
Report writing Report writing
Report writing
 
The technical writing process
The technical writing processThe technical writing process
The technical writing process
 
Report writing
Report writingReport writing
Report writing
 
Report writing
Report writingReport writing
Report writing
 
Writting process
Writting processWritting process
Writting process
 
Short Report Presentation
Short Report PresentationShort Report Presentation
Short Report Presentation
 
Report writing
Report writingReport writing
Report writing
 
Short, Informal Reports
Short, Informal ReportsShort, Informal Reports
Short, Informal Reports
 
Report writing
Report writingReport writing
Report writing
 

Similar to Creating technical document

Features of technical writing.pptx
Features of technical writing.pptxFeatures of technical writing.pptx
Features of technical writing.pptxalihamza797873
 
Technical article writing
Technical article writingTechnical article writing
Technical article writingKumar
 
An introduction to Technical Report Writing
An introduction to Technical Report WritingAn introduction to Technical Report Writing
An introduction to Technical Report Writingassande01
 
Lecture 1. an introduction to technical report writing
Lecture 1.   an introduction to technical report writingLecture 1.   an introduction to technical report writing
Lecture 1. an introduction to technical report writingAzamBaloch6
 
Style in technical writting
Style in technical writtingStyle in technical writting
Style in technical writtingmadhumitha A
 
Technical writing and management skill.pptx
Technical writing and management skill.pptxTechnical writing and management skill.pptx
Technical writing and management skill.pptxMuhammadSalman585
 
EST 200, Oral and Written Communications
EST 200, Oral and Written CommunicationsEST 200, Oral and Written Communications
EST 200, Oral and Written CommunicationsCKSunith1
 
Report writing and technical report writing
Report writing and technical report writingReport writing and technical report writing
Report writing and technical report writingKawishBhatti1
 
Presentation of Chapter 01 Technical Writing
Presentation of Chapter 01  Technical WritingPresentation of Chapter 01  Technical Writing
Presentation of Chapter 01 Technical WritingMagdi Saadawi
 
STYLES_IN_TECHNICAL22.pptx
STYLES_IN_TECHNICAL22.pptxSTYLES_IN_TECHNICAL22.pptx
STYLES_IN_TECHNICAL22.pptxBhavikAneja1
 
technical Communication and report writing
technical Communication and report writingtechnical Communication and report writing
technical Communication and report writingBilal shafique
 
160210116019 General And Technical Communication
160210116019    General And Technical Communication160210116019    General And Technical Communication
160210116019 General And Technical CommunicationSandip Hapani
 
An Intro To Technical Writing
An Intro To Technical WritingAn Intro To Technical Writing
An Intro To Technical Writingmrskrogers
 
general vs technical communicatonss.pptx
general vs technical communicatonss.pptxgeneral vs technical communicatonss.pptx
general vs technical communicatonss.pptxgovindshastriji01
 
Stc halfday tech-edit_23apr_final
Stc halfday tech-edit_23apr_finalStc halfday tech-edit_23apr_final
Stc halfday tech-edit_23apr_finalLinda Oestreich
 
Writing Technical Report: Detailed Guide
Writing Technical Report: Detailed GuideWriting Technical Report: Detailed Guide
Writing Technical Report: Detailed GuideTechnical Report
 
Technical writings for academics
Technical writings for academicsTechnical writings for academics
Technical writings for academicsTapan Barui
 

Similar to Creating technical document (20)

Features of technical writing.pptx
Features of technical writing.pptxFeatures of technical writing.pptx
Features of technical writing.pptx
 
Technical article writing
Technical article writingTechnical article writing
Technical article writing
 
An introduction to Technical Report Writing
An introduction to Technical Report WritingAn introduction to Technical Report Writing
An introduction to Technical Report Writing
 
Lecture 1. an introduction to technical report writing
Lecture 1.   an introduction to technical report writingLecture 1.   an introduction to technical report writing
Lecture 1. an introduction to technical report writing
 
Chapter Two.pptx
Chapter Two.pptxChapter Two.pptx
Chapter Two.pptx
 
Style in technical writting
Style in technical writtingStyle in technical writting
Style in technical writting
 
Technical writing and management skill.pptx
Technical writing and management skill.pptxTechnical writing and management skill.pptx
Technical writing and management skill.pptx
 
EST 200, Oral and Written Communications
EST 200, Oral and Written CommunicationsEST 200, Oral and Written Communications
EST 200, Oral and Written Communications
 
Report writing and technical report writing
Report writing and technical report writingReport writing and technical report writing
Report writing and technical report writing
 
Presentation of Chapter 01 Technical Writing
Presentation of Chapter 01  Technical WritingPresentation of Chapter 01  Technical Writing
Presentation of Chapter 01 Technical Writing
 
STYLES_IN_TECHNICAL22.pptx
STYLES_IN_TECHNICAL22.pptxSTYLES_IN_TECHNICAL22.pptx
STYLES_IN_TECHNICAL22.pptx
 
technical Communication and report writing
technical Communication and report writingtechnical Communication and report writing
technical Communication and report writing
 
160210116019 General And Technical Communication
160210116019    General And Technical Communication160210116019    General And Technical Communication
160210116019 General And Technical Communication
 
An Intro To Technical Writing
An Intro To Technical WritingAn Intro To Technical Writing
An Intro To Technical Writing
 
general vs technical communicatonss.pptx
general vs technical communicatonss.pptxgeneral vs technical communicatonss.pptx
general vs technical communicatonss.pptx
 
Stc halfday tech-edit_23apr_final
Stc halfday tech-edit_23apr_finalStc halfday tech-edit_23apr_final
Stc halfday tech-edit_23apr_final
 
Writing Technical Report: Detailed Guide
Writing Technical Report: Detailed GuideWriting Technical Report: Detailed Guide
Writing Technical Report: Detailed Guide
 
Technical writings for academics
Technical writings for academicsTechnical writings for academics
Technical writings for academics
 
TECHNICAL WRITING.pdf
TECHNICAL WRITING.pdfTECHNICAL WRITING.pdf
TECHNICAL WRITING.pdf
 
Recommendation Report
Recommendation ReportRecommendation Report
Recommendation Report
 

Recently uploaded

ICT role in 21st century education and it's challenges.
ICT role in 21st century education and it's challenges.ICT role in 21st century education and it's challenges.
ICT role in 21st century education and it's challenges.MaryamAhmad92
 
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.pptxAreebaZafar22
 
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural Resources
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural ResourcesEnergy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural Resources
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural ResourcesShubhangi Sonawane
 
Z Score,T Score, Percential Rank and Box Plot Graph
Z Score,T Score, Percential Rank and Box Plot GraphZ Score,T Score, Percential Rank and Box Plot Graph
Z Score,T Score, Percential Rank and Box Plot GraphThiyagu K
 
psychiatric nursing HISTORY COLLECTION .docx
psychiatric  nursing HISTORY  COLLECTION  .docxpsychiatric  nursing HISTORY  COLLECTION  .docx
psychiatric nursing HISTORY COLLECTION .docxPoojaSen20
 
PROCESS RECORDING FORMAT.docx
PROCESS      RECORDING        FORMAT.docxPROCESS      RECORDING        FORMAT.docx
PROCESS RECORDING FORMAT.docxPoojaSen20
 
Measures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and ModeMeasures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and ModeThiyagu K
 
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.pdfQucHHunhnh
 
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.pptxnegromaestrong
 
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in DelhiRussian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhikauryashika82
 
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...Shubhangi Sonawane
 
Nutritional Needs Presentation - HLTH 104
Nutritional Needs Presentation - HLTH 104Nutritional Needs Presentation - HLTH 104
Nutritional Needs Presentation - HLTH 104misteraugie
 
ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701bronxfugly43
 
Food Chain and Food Web (Ecosystem) EVS, B. Pharmacy 1st Year, Sem-II
Food Chain and Food Web (Ecosystem) EVS, B. Pharmacy 1st Year, Sem-IIFood Chain and Food Web (Ecosystem) EVS, B. Pharmacy 1st Year, Sem-II
Food Chain and Food Web (Ecosystem) EVS, B. Pharmacy 1st Year, Sem-IIShubhangi Sonawane
 
Measures of Dispersion and Variability: Range, QD, AD and SD
Measures of Dispersion and Variability: Range, QD, AD and SDMeasures of Dispersion and Variability: Range, QD, AD and SD
Measures of Dispersion and Variability: Range, QD, AD and SDThiyagu K
 
The basics of sentences session 3pptx.pptx
The basics of sentences session 3pptx.pptxThe basics of sentences session 3pptx.pptx
The basics of sentences session 3pptx.pptxheathfieldcps1
 
Role Of Transgenic Animal In Target Validation-1.pptx
Role Of Transgenic Animal In Target Validation-1.pptxRole Of Transgenic Animal In Target Validation-1.pptx
Role Of Transgenic Animal In Target Validation-1.pptxNikitaBankoti2
 
Basic Civil Engineering first year Notes- Chapter 4 Building.pptx
Basic Civil Engineering first year Notes- Chapter 4 Building.pptxBasic Civil Engineering first year Notes- Chapter 4 Building.pptx
Basic Civil Engineering first year Notes- Chapter 4 Building.pptxDenish Jangid
 
Class 11th Physics NEET formula sheet pdf
Class 11th Physics NEET formula sheet pdfClass 11th Physics NEET formula sheet pdf
Class 11th Physics NEET formula sheet pdfAyushMahapatra5
 

Recently uploaded (20)

ICT role in 21st century education and it's challenges.
ICT role in 21st century education and it's challenges.ICT role in 21st century education and it's challenges.
ICT role in 21st century education and it's challenges.
 
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
 
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural Resources
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural ResourcesEnergy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural Resources
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural Resources
 
Z Score,T Score, Percential Rank and Box Plot Graph
Z Score,T Score, Percential Rank and Box Plot GraphZ Score,T Score, Percential Rank and Box Plot Graph
Z Score,T Score, Percential Rank and Box Plot Graph
 
psychiatric nursing HISTORY COLLECTION .docx
psychiatric  nursing HISTORY  COLLECTION  .docxpsychiatric  nursing HISTORY  COLLECTION  .docx
psychiatric nursing HISTORY COLLECTION .docx
 
PROCESS RECORDING FORMAT.docx
PROCESS      RECORDING        FORMAT.docxPROCESS      RECORDING        FORMAT.docx
PROCESS RECORDING FORMAT.docx
 
Measures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and ModeMeasures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and Mode
 
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
 
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
 
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
 
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in DelhiRussian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
 
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...
 
Nutritional Needs Presentation - HLTH 104
Nutritional Needs Presentation - HLTH 104Nutritional Needs Presentation - HLTH 104
Nutritional Needs Presentation - HLTH 104
 
ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701
 
Food Chain and Food Web (Ecosystem) EVS, B. Pharmacy 1st Year, Sem-II
Food Chain and Food Web (Ecosystem) EVS, B. Pharmacy 1st Year, Sem-IIFood Chain and Food Web (Ecosystem) EVS, B. Pharmacy 1st Year, Sem-II
Food Chain and Food Web (Ecosystem) EVS, B. Pharmacy 1st Year, Sem-II
 
Measures of Dispersion and Variability: Range, QD, AD and SD
Measures of Dispersion and Variability: Range, QD, AD and SDMeasures of Dispersion and Variability: Range, QD, AD and SD
Measures of Dispersion and Variability: Range, QD, AD and SD
 
The basics of sentences session 3pptx.pptx
The basics of sentences session 3pptx.pptxThe basics of sentences session 3pptx.pptx
The basics of sentences session 3pptx.pptx
 
Role Of Transgenic Animal In Target Validation-1.pptx
Role Of Transgenic Animal In Target Validation-1.pptxRole Of Transgenic Animal In Target Validation-1.pptx
Role Of Transgenic Animal In Target Validation-1.pptx
 
Basic Civil Engineering first year Notes- Chapter 4 Building.pptx
Basic Civil Engineering first year Notes- Chapter 4 Building.pptxBasic Civil Engineering first year Notes- Chapter 4 Building.pptx
Basic Civil Engineering first year Notes- Chapter 4 Building.pptx
 
Class 11th Physics NEET formula sheet pdf
Class 11th Physics NEET formula sheet pdfClass 11th Physics NEET formula sheet pdf
Class 11th Physics NEET formula sheet pdf
 

Creating technical document

  • 2. TECHNICAL DOCUMENT Technical writing requires objective analysis and clear presentation. It is imperative to act professionally and ethically in all dealings with specific audience, the public and government agencies. Steps for successful writing are: • Preparation • Research • Organization • Writing a draft • Revision
  • 3. WRITING TECHNICAL DOCUMENT • The goal of technical writing is to enable readers to use a technology or understand a process or concept. • Because the subject matter is more important than the writer’s voice, technical writing style uses an objective, not a subjective, tone.
  • 4. WRITING TECHNICAL DOCUMENT • The writing style is direct and utilitarian, emphasizing exactness and clarity rather than elegance or allusiveness. • A technical writer uses figurative language only when a figure of speech would facilitate understanding.
  • 5. WRITING TECHNICAL DOCUMENT • Technical writing is often—but not always—aimed at readers who are not experts in the subject, such as consumers or employees learning to operate unfamiliar equipment. • Because such audiences are inexperienced and the procedures described may involve hazardous material or equipment, clarity becomes an ethical as well as a stylistic concern.
  • 6. WRITING TECHNICAL DOCUMENT • Technical writing style may use a technical vocabulary appropriate for the reader. • Good technical writing also avoids overusing the passive voice.
  • 7. ETHICAL PRINCIPLES • Avoid language that attempts to evade responsibility • Avoid language that could possibly mislead readers • Do not de-emphasize or suppress important information • Do not emphasize misleading or incorrect information • Treat others fairly and respectfully
  • 8. STYLE & USAGE • Elements of style- • Present Tense, active voice • Simple sentences • Gender neutrality • Abbreviations and acronyms • Lists • Sidebars • Figures and Tables • Cross-references • Footnotes and endnotes • Redundancy • Final edit
  • 9. REFERENCE Alred, Brusaw & Oliu. (2011). The Handbook of Technical Writing, Ninth Edition