SlideShare a Scribd company logo
1 of 26
Who’s reporting?
BSED-ENGLISH
Catherine
Esteban
Nolyn Angelique
Manalo
Mary Divine
Samoy
Mojarri
Villacencio
Principles of Technical Writing
DESCRIPTION
1 2 3 4 5
principles of
Technical writing
WHAT IS TECHNICAL WRITING
Technical Writing, sometimes called business writing, is writing for a
specific purpose and with a specific goal. Usually its goal is to
inform/instruct or persuade/argue. Technical writing can really be
considered transactional writing because there are two people or
groups involved in the communication.
Why is Technical Writing
Important?
PRINCIPLES OF TECHNICAL
WRITING
1. USE GOOD GRAMMAR
1. Use Good Grammar
Your readers expect technical documents to be written in
standard English. Certain grammatical errors can actually cause
your reader to misinterpret the information. However, because
technical documents must be precise and accurate, readers expect
documents to be professional, polished, and flawless.
One grammatical rule to adhere to is subject-verb agreement.
One employee is absent.
Two employee’s are absent
This subject-verb agreement is easy to make because in each sentence,
the subject is obvious
employee in the first sentence agrees with is and employees in the second
sentence agrees with are.
The real challenge is when the subject is not as obvious
2. WRITING CONCISELY
2.Writing Concisely
In technical writing, clarity and brevity is your goal. Why
take 32 words to express what could be stated in 14 or 15? The
dictates of effective technical writing suggest that the average
length for a sentence is 15-20 words.
3. USING THE ACTIVE
VOICE
3.Using the Active Voice
Imperative sentences, or command sentences, are written in the
active voice. The active voice is more natural to people when they speak,
but technical writers often turn to the passive voice when writing
technical documents. One of the main reasons you should use the active
voice rather than the passive in technical writing is the active voice more
closely resembles the way people remember and process information
Compare the following sentences:
Staff hours are calculated by the manager on the actual work load.
The manager calculates staff hours on the actual work load.
In the active voice sentence,the subject acts. In the passive voice
sentence, something is done to the subject. Another reason to avoid the
passive voice sentence is you run the risk of omitting the doer of the
action.
Another reason to avoid the passive voice sentence is you run the risk
of omitting the doer of the action. Note the absence of the "doer" in
the following sentence:
Documented practical examinations will be given for backhoes of the
same type with different operating characteristics.
Your reader will probably wonder who will give the practical
examinations. If the technical writer had used the active voice, the
"doer" would be clear.
4. USING POSITIVE
STATEMENTS
4.Using Positive Statements
Technical writers should word instructions as positive
statements. Whenever possible, phrase commands in a
positive manner.
5. AVOID LONG
SENTENCES
5. Avoiding Long Sentences
Short sentences are easier to understand than long sentences.
For this reason, it is best to write your technical documents in
short sentences. If you are asking your readers to perform several
actions, begin the step with an active verb.
When separating steps into distinct bullet points is to make sure that the
action verbs in each bulleted item are in the same tense.
For example, if the first step was worded, "Creating an empty workspace
," then the next bullet would be, "Populating it with application source
code ," and the third bullet point would be, "Compiling the workspace ."
6. USING STANDARD
PUNCTUATION
5. Using Standard Punctuation
Your readers expect standard punctuation when they read your documents.
Complicated or "creative" punctuation will confuse them. One suggestion is to select
syntax that minimizes the need for punctuation. You may wish to divide compound
or complex sentences into shorter sentences to avoid excessive or confusing
punctuation.
One example of this is deciding where to place your commas, periods, colons, and
semicolons when using quotation marks. Commas and periods always go inside the
closing quotation mark.
EXAMPLES
1. We are "struggling young artists," but we hope to become successful.
2. Most corporations adopt the belief, "the customer is always right."
3. On the other hand, semicolons and colons are always placed outside the
quotation marks.
EXAMPLES
1. These actors can deliver "box office hits": Tom Cruise, Tom Hanks, Johnny
Depp.
2. Look in the manual under "text messaging"; the directions are very clear.
CONCLUSION
THANK YOU FOR
LISTENING!

More Related Content

What's hot

Types of deviation
Types of deviationTypes of deviation
Types of deviationAmer Minhas
 
Technical Writing PowerPoint
Technical Writing PowerPointTechnical Writing PowerPoint
Technical Writing PowerPointkgillesss
 
Communicative competence slides
Communicative competence slidesCommunicative competence slides
Communicative competence slidessonsedela
 
STYLISTICS: Discourse and Context 1: Function
STYLISTICS: Discourse and Context 1: FunctionSTYLISTICS: Discourse and Context 1: Function
STYLISTICS: Discourse and Context 1: Functionahsirt
 
Communicative competence
Communicative competenceCommunicative competence
Communicative competenceDrew F
 
Elements of Functional English
Elements of Functional EnglishElements of Functional English
Elements of Functional Englishm nagaRAJU
 
Style as choice
Style as choice Style as choice
Style as choice Asif Ali
 
Views about language
Views about languageViews about language
Views about languageShiela Aringo
 
Technical writing process
Technical writing processTechnical writing process
Technical writing processsaurabh kaushik
 
Presentation zadi, Origin of Language
Presentation zadi, Origin of LanguagePresentation zadi, Origin of Language
Presentation zadi, Origin of LanguageZadi Rafique
 
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
 

What's hot (20)

Types of deviation
Types of deviationTypes of deviation
Types of deviation
 
Technical Writing PowerPoint
Technical Writing PowerPointTechnical Writing PowerPoint
Technical Writing PowerPoint
 
Stylistics
StylisticsStylistics
Stylistics
 
Foregrounding
ForegroundingForegrounding
Foregrounding
 
Communicative competence slides
Communicative competence slidesCommunicative competence slides
Communicative competence slides
 
STYLISTICS: Discourse and Context 1: Function
STYLISTICS: Discourse and Context 1: FunctionSTYLISTICS: Discourse and Context 1: Function
STYLISTICS: Discourse and Context 1: Function
 
Communicative competence
Communicative competenceCommunicative competence
Communicative competence
 
Elements of Functional English
Elements of Functional EnglishElements of Functional English
Elements of Functional English
 
Michael halliday
Michael hallidayMichael halliday
Michael halliday
 
Style as choice
Style as choice Style as choice
Style as choice
 
World english
World englishWorld english
World english
 
Views about language
Views about languageViews about language
Views about language
 
Technical writing process
Technical writing processTechnical writing process
Technical writing process
 
Cohesion and coherence
Cohesion and coherenceCohesion and coherence
Cohesion and coherence
 
STYLISTICS: What is rhetoric
STYLISTICS: What is rhetoricSTYLISTICS: What is rhetoric
STYLISTICS: What is rhetoric
 
Presentation zadi, Origin of Language
Presentation zadi, Origin of LanguagePresentation zadi, Origin of Language
Presentation zadi, Origin of Language
 
Discourse types
Discourse typesDiscourse types
Discourse types
 
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
 
Cohesion and coherence
Cohesion and coherenceCohesion and coherence
Cohesion and coherence
 
Esp syllabus
Esp syllabusEsp syllabus
Esp syllabus
 

Similar to Principles of technical writing

Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)Adrienne Bellehumeur
 
Chapter 4 Using an Appropriate StyleFIRST FORMAL LETTER ASSIG.docx
Chapter 4 Using an Appropriate StyleFIRST FORMAL LETTER ASSIG.docxChapter 4 Using an Appropriate StyleFIRST FORMAL LETTER ASSIG.docx
Chapter 4 Using an Appropriate StyleFIRST FORMAL LETTER ASSIG.docxrobertad6
 
Publishability workshop: Writing readable academic text
Publishability workshop: Writing readable academic textPublishability workshop: Writing readable academic text
Publishability workshop: Writing readable academic textLawrie Hunter
 
December 12, 2019 GRIPS readability workshop
December 12, 2019 GRIPS readability workshopDecember 12, 2019 GRIPS readability workshop
December 12, 2019 GRIPS readability workshopLawrie Hunter
 
Business Communications Chapter 3 notes
Business Communications Chapter 3 notesBusiness Communications Chapter 3 notes
Business Communications Chapter 3 notescwood
 
12 Frequently Asked Questions About Legal Writing Samples.pptx
12 Frequently Asked Questions About Legal Writing Samples.pptx12 Frequently Asked Questions About Legal Writing Samples.pptx
12 Frequently Asked Questions About Legal Writing Samples.pptxBCG Attorney Search
 
Technical English for Engineers | Mechanical Engineer | Audit Course - III
Technical English for Engineers | Mechanical Engineer | Audit Course - III Technical English for Engineers | Mechanical Engineer | Audit Course - III
Technical English for Engineers | Mechanical Engineer | Audit Course - III Yash Sawant
 
Auditing StudentsDecember 18, 2008Page 5MEMORANDUMTO.docx
Auditing StudentsDecember 18, 2008Page 5MEMORANDUMTO.docxAuditing StudentsDecember 18, 2008Page 5MEMORANDUMTO.docx
Auditing StudentsDecember 18, 2008Page 5MEMORANDUMTO.docxikirkton
 
Technical Writing For Consultants
Technical Writing For ConsultantsTechnical Writing For Consultants
Technical Writing For Consultantsrlucera
 
Writing Easy to Comprehend Academic Papers
Writing Easy to Comprehend Academic PapersWriting Easy to Comprehend Academic Papers
Writing Easy to Comprehend Academic PapersManagement Paper
 
SEE-20-STRUCTURE-OF-Technical writing.pptx
SEE-20-STRUCTURE-OF-Technical writing.pptxSEE-20-STRUCTURE-OF-Technical writing.pptx
SEE-20-STRUCTURE-OF-Technical writing.pptxMelayAlmorado1
 
Effective Proofreading Strategies to Ensure Error-free Writing
Effective Proofreading Strategies to Ensure Error-free WritingEffective Proofreading Strategies to Ensure Error-free Writing
Effective Proofreading Strategies to Ensure Error-free WritingMOS Legal Transcription Service
 
Technical writing made easier
Technical writing made easierTechnical writing made easier
Technical writing made easierFauzi Rakhman
 
WritingProcessForBusinessAnalysis-Guide
WritingProcessForBusinessAnalysis-GuideWritingProcessForBusinessAnalysis-Guide
WritingProcessForBusinessAnalysis-GuideJas Mahay
 
STIMULATING THE PHILIPPINES WORKPLACE
STIMULATING THE PHILIPPINES WORKPLACESTIMULATING THE PHILIPPINES WORKPLACE
STIMULATING THE PHILIPPINES WORKPLACEjessiemarietan1
 
Not Your Father's Resume Two
Not Your Father's Resume TwoNot Your Father's Resume Two
Not Your Father's Resume TwoBrian Holihan
 

Similar to Principles of technical writing (20)

Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
 
Chapter 4 Using an Appropriate StyleFIRST FORMAL LETTER ASSIG.docx
Chapter 4 Using an Appropriate StyleFIRST FORMAL LETTER ASSIG.docxChapter 4 Using an Appropriate StyleFIRST FORMAL LETTER ASSIG.docx
Chapter 4 Using an Appropriate StyleFIRST FORMAL LETTER ASSIG.docx
 
Publishability workshop: Writing readable academic text
Publishability workshop: Writing readable academic textPublishability workshop: Writing readable academic text
Publishability workshop: Writing readable academic text
 
Re-writing & Proof-reading
Re-writing & Proof-readingRe-writing & Proof-reading
Re-writing & Proof-reading
 
December 12, 2019 GRIPS readability workshop
December 12, 2019 GRIPS readability workshopDecember 12, 2019 GRIPS readability workshop
December 12, 2019 GRIPS readability workshop
 
Business Communications Chapter 3 notes
Business Communications Chapter 3 notesBusiness Communications Chapter 3 notes
Business Communications Chapter 3 notes
 
12 Frequently Asked Questions About Legal Writing Samples.pptx
12 Frequently Asked Questions About Legal Writing Samples.pptx12 Frequently Asked Questions About Legal Writing Samples.pptx
12 Frequently Asked Questions About Legal Writing Samples.pptx
 
Technical English for Engineers | Mechanical Engineer | Audit Course - III
Technical English for Engineers | Mechanical Engineer | Audit Course - III Technical English for Engineers | Mechanical Engineer | Audit Course - III
Technical English for Engineers | Mechanical Engineer | Audit Course - III
 
Auditing StudentsDecember 18, 2008Page 5MEMORANDUMTO.docx
Auditing StudentsDecember 18, 2008Page 5MEMORANDUMTO.docxAuditing StudentsDecember 18, 2008Page 5MEMORANDUMTO.docx
Auditing StudentsDecember 18, 2008Page 5MEMORANDUMTO.docx
 
45351693.Dnl
45351693.Dnl45351693.Dnl
45351693.Dnl
 
Technical Writing For Consultants
Technical Writing For ConsultantsTechnical Writing For Consultants
Technical Writing For Consultants
 
Writing Easy to Comprehend Academic Papers
Writing Easy to Comprehend Academic PapersWriting Easy to Comprehend Academic Papers
Writing Easy to Comprehend Academic Papers
 
SEE-20-STRUCTURE-OF-Technical writing.pptx
SEE-20-STRUCTURE-OF-Technical writing.pptxSEE-20-STRUCTURE-OF-Technical writing.pptx
SEE-20-STRUCTURE-OF-Technical writing.pptx
 
Azam baloch
Azam balochAzam baloch
Azam baloch
 
Effective Proofreading Strategies to Ensure Error-free Writing
Effective Proofreading Strategies to Ensure Error-free WritingEffective Proofreading Strategies to Ensure Error-free Writing
Effective Proofreading Strategies to Ensure Error-free Writing
 
Technical writing made easier
Technical writing made easierTechnical writing made easier
Technical writing made easier
 
WritingProcessForBusinessAnalysis-Guide
WritingProcessForBusinessAnalysis-GuideWritingProcessForBusinessAnalysis-Guide
WritingProcessForBusinessAnalysis-Guide
 
STIMULATING THE PHILIPPINES WORKPLACE
STIMULATING THE PHILIPPINES WORKPLACESTIMULATING THE PHILIPPINES WORKPLACE
STIMULATING THE PHILIPPINES WORKPLACE
 
Clark ch 8 and 9
Clark ch 8 and 9Clark ch 8 and 9
Clark ch 8 and 9
 
Not Your Father's Resume Two
Not Your Father's Resume TwoNot Your Father's Resume Two
Not Your Father's Resume Two
 

Recently uploaded

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
 
Spellings Wk 3 English CAPS CARES Please Practise
Spellings Wk 3 English CAPS CARES Please PractiseSpellings Wk 3 English CAPS CARES Please Practise
Spellings Wk 3 English CAPS CARES Please PractiseAnaAcapella
 
How to Give a Domain for a Field in Odoo 17
How to Give a Domain for a Field in Odoo 17How to Give a Domain for a Field in Odoo 17
How to Give a Domain for a Field in Odoo 17Celine George
 
Making communications land - Are they received and understood as intended? we...
Making communications land - Are they received and understood as intended? we...Making communications land - Are they received and understood as intended? we...
Making communications land - Are they received and understood as intended? we...Association for Project Management
 
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 . pdfQucHHunhnh
 
Holdier Curriculum Vitae (April 2024).pdf
Holdier Curriculum Vitae (April 2024).pdfHoldier Curriculum Vitae (April 2024).pdf
Holdier Curriculum Vitae (April 2024).pdfagholdier
 
This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.christianmathematics
 
Jual Obat Aborsi Hongkong ( Asli No.1 ) 085657271886 Obat Penggugur Kandungan...
Jual Obat Aborsi Hongkong ( Asli No.1 ) 085657271886 Obat Penggugur Kandungan...Jual Obat Aborsi Hongkong ( Asli No.1 ) 085657271886 Obat Penggugur Kandungan...
Jual Obat Aborsi Hongkong ( Asli No.1 ) 085657271886 Obat Penggugur Kandungan...ZurliaSoop
 
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdfUGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdfNirmal Dwivedi
 
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
 
Sociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning ExhibitSociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning Exhibitjbellavia9
 
Magic bus Group work1and 2 (Team 3).pptx
Magic bus Group work1and 2 (Team 3).pptxMagic bus Group work1and 2 (Team 3).pptx
Magic bus Group work1and 2 (Team 3).pptxdhanalakshmis0310
 
General Principles of Intellectual Property: Concepts of Intellectual Proper...
General Principles of Intellectual Property: Concepts of Intellectual  Proper...General Principles of Intellectual Property: Concepts of Intellectual  Proper...
General Principles of Intellectual Property: Concepts of Intellectual Proper...Poonam Aher Patil
 
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 FellowsMebane Rash
 
Application orientated numerical on hev.ppt
Application orientated numerical on hev.pptApplication orientated numerical on hev.ppt
Application orientated numerical on hev.pptRamjanShidvankar
 
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).pptxVishalSingh1417
 
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
 
Python Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docxPython Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docxRamakrishna Reddy Bijjam
 
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).pptxVishalSingh1417
 

Recently uploaded (20)

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
 
Spellings Wk 3 English CAPS CARES Please Practise
Spellings Wk 3 English CAPS CARES Please PractiseSpellings Wk 3 English CAPS CARES Please Practise
Spellings Wk 3 English CAPS CARES Please Practise
 
How to Give a Domain for a Field in Odoo 17
How to Give a Domain for a Field in Odoo 17How to Give a Domain for a Field in Odoo 17
How to Give a Domain for a Field in Odoo 17
 
Making communications land - Are they received and understood as intended? we...
Making communications land - Are they received and understood as intended? we...Making communications land - Are they received and understood as intended? we...
Making communications land - Are they received and understood as intended? we...
 
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
 
This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.
 
Jual Obat Aborsi Hongkong ( Asli No.1 ) 085657271886 Obat Penggugur Kandungan...
Jual Obat Aborsi Hongkong ( Asli No.1 ) 085657271886 Obat Penggugur Kandungan...Jual Obat Aborsi Hongkong ( Asli No.1 ) 085657271886 Obat Penggugur Kandungan...
Jual Obat Aborsi Hongkong ( Asli No.1 ) 085657271886 Obat Penggugur Kandungan...
 
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdfUGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
 
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
 
Sociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning ExhibitSociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning Exhibit
 
Magic bus Group work1and 2 (Team 3).pptx
Magic bus Group work1and 2 (Team 3).pptxMagic bus Group work1and 2 (Team 3).pptx
Magic bus Group work1and 2 (Team 3).pptx
 
Asian American Pacific Islander Month DDSD 2024.pptx
Asian American Pacific Islander Month DDSD 2024.pptxAsian American Pacific Islander Month DDSD 2024.pptx
Asian American Pacific Islander Month DDSD 2024.pptx
 
General Principles of Intellectual Property: Concepts of Intellectual Proper...
General Principles of Intellectual Property: Concepts of Intellectual  Proper...General Principles of Intellectual Property: Concepts of Intellectual  Proper...
General Principles of Intellectual Property: Concepts of Intellectual Proper...
 
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
 
Application orientated numerical on hev.ppt
Application orientated numerical on hev.pptApplication orientated numerical on hev.ppt
Application orientated numerical on hev.ppt
 
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 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.
 
Python Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docxPython Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docx
 
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
 

Principles of technical writing

  • 1.
  • 2.
  • 4. Principles of Technical Writing DESCRIPTION 1 2 3 4 5
  • 5. principles of Technical writing WHAT IS TECHNICAL WRITING Technical Writing, sometimes called business writing, is writing for a specific purpose and with a specific goal. Usually its goal is to inform/instruct or persuade/argue. Technical writing can really be considered transactional writing because there are two people or groups involved in the communication.
  • 6. Why is Technical Writing Important?
  • 8. 1. USE GOOD GRAMMAR
  • 9. 1. Use Good Grammar Your readers expect technical documents to be written in standard English. Certain grammatical errors can actually cause your reader to misinterpret the information. However, because technical documents must be precise and accurate, readers expect documents to be professional, polished, and flawless.
  • 10. One grammatical rule to adhere to is subject-verb agreement. One employee is absent. Two employee’s are absent This subject-verb agreement is easy to make because in each sentence, the subject is obvious employee in the first sentence agrees with is and employees in the second sentence agrees with are. The real challenge is when the subject is not as obvious
  • 12. 2.Writing Concisely In technical writing, clarity and brevity is your goal. Why take 32 words to express what could be stated in 14 or 15? The dictates of effective technical writing suggest that the average length for a sentence is 15-20 words.
  • 13. 3. USING THE ACTIVE VOICE
  • 14. 3.Using the Active Voice Imperative sentences, or command sentences, are written in the active voice. The active voice is more natural to people when they speak, but technical writers often turn to the passive voice when writing technical documents. One of the main reasons you should use the active voice rather than the passive in technical writing is the active voice more closely resembles the way people remember and process information
  • 15. Compare the following sentences: Staff hours are calculated by the manager on the actual work load. The manager calculates staff hours on the actual work load. In the active voice sentence,the subject acts. In the passive voice sentence, something is done to the subject. Another reason to avoid the passive voice sentence is you run the risk of omitting the doer of the action.
  • 16. Another reason to avoid the passive voice sentence is you run the risk of omitting the doer of the action. Note the absence of the "doer" in the following sentence: Documented practical examinations will be given for backhoes of the same type with different operating characteristics. Your reader will probably wonder who will give the practical examinations. If the technical writer had used the active voice, the "doer" would be clear.
  • 18. 4.Using Positive Statements Technical writers should word instructions as positive statements. Whenever possible, phrase commands in a positive manner.
  • 20. 5. Avoiding Long Sentences Short sentences are easier to understand than long sentences. For this reason, it is best to write your technical documents in short sentences. If you are asking your readers to perform several actions, begin the step with an active verb.
  • 21. When separating steps into distinct bullet points is to make sure that the action verbs in each bulleted item are in the same tense. For example, if the first step was worded, "Creating an empty workspace ," then the next bullet would be, "Populating it with application source code ," and the third bullet point would be, "Compiling the workspace ."
  • 23. 5. Using Standard Punctuation Your readers expect standard punctuation when they read your documents. Complicated or "creative" punctuation will confuse them. One suggestion is to select syntax that minimizes the need for punctuation. You may wish to divide compound or complex sentences into shorter sentences to avoid excessive or confusing punctuation. One example of this is deciding where to place your commas, periods, colons, and semicolons when using quotation marks. Commas and periods always go inside the closing quotation mark.
  • 24. EXAMPLES 1. We are "struggling young artists," but we hope to become successful. 2. Most corporations adopt the belief, "the customer is always right." 3. On the other hand, semicolons and colons are always placed outside the quotation marks. EXAMPLES 1. These actors can deliver "box office hits": Tom Cruise, Tom Hanks, Johnny Depp. 2. Look in the manual under "text messaging"; the directions are very clear.