INTRO to Technical writing

Technical Writing Workshop

INTRO toTechnical writingPresenter: David SilversteinDate XX, 20101Overview50-min Presentation (with Q&A)

The Writing & Communications Center

Technical Writing ConsiderationsRhetoric & the Rhetorical TriangleWriting Process & Technical ConsiderationsReport Structure

2

WCC @ SITWriting & Communications Center at Stevens InstituteOne-on-one or group meetingsWriting & communication specialists210 Morton; www.stevens.edu/cal/wcc Free Any Stevens course, any semester! Monday to Friday 15pm

Walk-ins welcome. Appointments available.

3

WCC @ SITWCC Specialists can help:Organize report layoutRevise/edit term paperCraft bibliography/referencesShape presentations/slidesPractice speaking/deliveryExplain grammar, punctuation, syntax No Homework, No Busywork, No Grades 4Why?NAE concludes*: Elected representatives are ill-equipped to make decisions about tech-related issues.Students, parents & teachers remain uniformed about engineering and the contributions of the field which continues to deter students from studying engineering.Engineers often do not rise to management positions.*Raising Public Awareness of Engineering: National Academy of Engineering, National Academies Press, 2002.

5Why?

6Why?

7Why?

8Why?

91 Innovation 3 AudiencesCeramic Water Filters

Technological innovation:Used by multiple audiencesVarious business & technical sectors

10Ceramic Water Filters

Consumer LevelLanguage geared to a non-technical audience.Impact tailored to consumer-level audience11Ceramic Water Filters

Contract orBusiness LevelLanguage geared to a business-minded audience.Addresses audiences main concern: cost.12Ceramic Water Filters

TechnicalLevelLanguage geared to a technical audience.Presentation follows technical format.Specific values are highlighted.13Presidential Quotes FROM GEORGE W. BUSH"Rarely is the question asked: is our children learning." Florence, SC, Jan. 11, 2000 "I think we agree, the past is over." Dallas Morning News, May 10, 2000 "I understand small business growth. I was one." New York Daily News, Feb. 19, 2000 "I know how hard it is for you to put food on your family." NH, Chamber of Commerce, Jan. 27, 2000 "We must all hear the universal call to like your neighbor just like you like to be liked yourself." An interesting twist on the proverb: Love thy neighbor. (Quote is from the Financial Times)"The reason we start a war is to fight a war, win a war, thereby causing no more war!" First Presidential debate"Will the highways on the Internet become more few?" Concord, NH, Jan. 29, 200014Insurance Quotes

15Language = ImagePeople make assumptions about you based on the language you use.IntelligenceEducationBackgroundInfluenceCredibilityTrustworthinessBiasesAuthorityCapabilityConfidence16Writing 4 QuestionsWho in this room is a writer?

Emails, IM, Texts, Essays, Reports, Cover Letters, Resumes, Directions, Applications, Journals, Blogs, Stories, Evaluations, Year End Reviews, Business Memos, Grant Proposals, Budget Proposals, Job Descriptions, Etc

How do you feel about writing? (-5)---------------------------------------------(0)---------------------------------------------(+5)

Why do people write?To express themselves, to change opinions, to change policies, to change neighborhood/world, to connect with others, to explain, to teach, to understand self, to learn, to generate business, to promote ideas, to get funding, to get a job, to get Why should you learn to write better?17RhetoricRhetoric is the effective use of languagein writing and/or speaking

to get what you want or to persuade.18Rhetoric ExampleSay you want $5. Say you want $50,000.

19An Argument Needs 3 Thingsrhetorical triangleYou [Writer Speaker]AudienceReasons20Rhetorical AppealsETHOSLOGOSPATHOSrhetorical triangleAudienceReasonsYou [Writer Speaker]21Rhetorical Appeals CanETHOSLOGOSPATHOS22Rhetorical Appeals CanETHOSLOGOSPATHOSH23LOGOSPATHOSrhetorical triangleAudienceReasonsYou [Writer Speaker]ETHOSRhetorical Appeals24Rhetorical AppealsEthos = Appeals to your credibility or trustworthiness.

Ethos is created by:Highlighting your backgroundConsidering material in depthBeing fair & rational; seeing both sidesUsing relevant dictionInvoking other credible sources25Rhetorical AppealsLogos = Appeals to logic and reason

Logos is created by:Considering several reasons/solutionsExplaining logical progression/stepsExploring Pros & Cons of each ideaDefining criteriaUsing statistics, facts, numbers, figures26Rhetorical AppealsPathos = Appeals to values or emotions of audience

Pathos is created by:Knowing your audiences valuesFocusing on relevant pointsUsing audience-appropriate dictionCreating emotional metaphorsUsing descriptive, sensory detail27Rhetorical Appeals Examples

28Rhetorical Appeals Examples





33Rhetoric Recap Audience, Audience, Audience.How well do you know your audience?Different Audience = Different Approach

Who are you?Why should anyone listen to you?

Prove It.What are your reasons? Or solutions?34Tech writing Considerations35Writing ProcessWriting becomes more difficult when:You work out of orderYou skip a stageYou work on two stages at once

NOTE: WCC Specialists can help at any stage.36Imagine you are here and

37Writing vs. SpeakingHow do you present your info?Depends on Audience (parent/officer) = Audience Considerations Pre-arrange Items = Document OrganizationDisplay Objects (family photos) = Feature Relevant MaterialHide Certain Items = Consider Tone, DictionNote of Explanation = Thesis Placement38Writing vs. Speaking (Cont.)Written DocumentsConversation/PresentationOnce submitted author is no longer presentAuthor/Speaker is presentNo real-time adjustmentsCan adjust or clarify explanations in real-timeNeed to forecast questions and add answers in advanceCan allocate time for Q&AAppearance: Tone, Style, Layout, TyposAppearance: Intonation, Body Language, Dress, Slides39Technical Writing IssuesConsider Your Diction:ToneJargonIdioms, Euphemisms, DoublespeakAcronymsSexist LanguageCulturally Biased LanguagePlagiarismSpecifics & Details40Technical Writing ToneTone is the quality that reveals the attitudes and presuppositions of the author; a general quality, effect, or atmosphere.

Consider tone of voice:Wow, this is a great presentation.41Technical Writing Tone42Technical Writing Tone isAlmost any idea in any language can be written at least 10 different ways often 100.43Technical Writing JargonJargon isdiction specific to a certain field/communityconfusing & alienating to outsiders44Technical Writing JargonJargon isdiction specific to a certain field/communityconfusing & alienating to outsidersFieldJargon ExamplesMedicalTonsillectomy, paracentesis, c-spine, WBCLegalAffidavit, easement, surety, defeasanceMathematicsDuodecimal, standard deviation, LHSMilitaryBanana clip, butter bar, DOD, egg beaterEngineering?45Technical Writing IdiomsIdioms are linguistic/cultural phrases that do not translateInaccurate, confusing, and change by region46Technical Writing IdiomsIdioms are linguistic/cultural phrases that do not translateInaccurate, confusing, and change by regionAmerican IdiomsPossible MeaningA rolling stone gathers no moss.All bark and no bite.Mind your Ps and Qs.No dice.47Technical Writing IdiomsIdioms are linguistic/cultural phrases that do not translateInaccurate, confusing, and change by regionAmerican IdiomsPossible MeaningA rolling stone gathers no moss.An active person is more successful.All bark and no bite.Someone who exaggerates his/her worth.Mind your Ps and Qs.Be polite.No dice.Not possible.48Technical Writing IdiomsSwedish IdiomsPossible MeaningThrow yourself against the wall!There is no cow on the ice, as long as the back legs are on land.Theres a dog buried here!Make magic with your knees.49Technical Writing IdiomsSwedish IdiomsPossible MeaningThrow yourself against the wall!Get out of here!There is no cow on the ice, as long as the back legs are on land.Theres nothing to worry about yet.Theres a dog buried here!Something strange is happening!Make magic with your knees.Do the impossible.50Technical Writing EuphemismsEuphemisms arePolite IdiomsUsed to control perceptions (Minimize negatives & accentuate positives)Not specific & do not belong in technical writingEuphemism ExamplesRestroomFriendly fireBirds and the beesPass away51Technical Writing Continuum From Bad to WorseFrom Confusion to CrazyFrom Specific to Abstract52Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you were53Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you werelet godownsized54Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you werelet godownsizedinvoluntarily separated from payrollgiven a career change opportunitypart of a normal payroll adjustmentpart of restructuring55Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you werelet godownsizedinvoluntarily separated from payrollgiven a career change opportunitypart of a normal payroll adjustmentpart of restructuringLie It wasnt a lie, it was a56Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you werelet godownsizedinvoluntarily separated from payrollgiven a career change opportunitypart of a normal payroll adjustmentpart of restructuringLie It wasnt a lie, it was amisstatementmisspoke57Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you werelet godownsizedinvoluntarily separated from payrollgiven a career change opportunitypart of a normal payroll adjustmentpart of restructuringLie It wasnt a lie, it was amisstatementmisspokea strategic misrepresentationresult of a disorderterminological inexactitudebeing economical with the truth58Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you werelet godownsizedinvoluntarily separated from payrollgiven a career change opportunitypart of a normal payroll adjustmentpart of restructuringLie It wasnt a lie, it was amisstatementmisspokea strategic misrepresentationresult of a disorderterminological inexactitudebeing economical with the truthKillingIn war, it isnt killing, its59Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you werelet godownsizedinvoluntarily separated from payrollgiven a career change opportunitypart of a normal payroll adjustmentpart of restructuringLie It wasnt a lie, it was amisstatementmisspokea strategic misrepresentationresult of a disorderterminological inexactitudebeing economical with the truthKillingIn war, it isnt killing, itsneutralizingfriendly fire60Technical Writing DoublespeakDoublespeak is a euphemism taken to an absurd endpoint.TermEuphemismDoublespeakFired You werent fired, you werelet godownsizedinvoluntarily separated from payrollgiven a career change opportunitypart of a normal payroll adjustmentpart of restructuringLie It wasnt a lie, it was amisstatementmisspokea strategic misrepresentationresult of a disorderterminological inexactitudebeing economical with the truthKillingIn war, it isnt killing, itsneutralizingfriendly firecollateral damageservicing the targetexceeding the threshold of physiological damage61Technical Writing AcronymsAvoid acronyms/abbreviations in tech writingUnknown & confusingMultivalentSome are universally accepted: USA, PhD62Technical Writing AcronymsAcronymsMultiple MeaningBSMAMSSTAvoid acronyms/abbreviations in tech writingUnknown & confusingMultivalentSome are universally accepted: USA, PhD63Technical Writing AcronymsAvoid acronyms/abbreviations in tech writingUnknown & confusingMultivalentSome are universally accepted: USA, PhDAcronymsMultiple MeaningBSBachelor of Science, Backspace, Balance SheetMAMassachusetts, Maintenance, Master of ArtsMSMaster of Science, Miss, Microsoft, Med StudentSTSaint, Street, Short Term, State64Technical Writing AcronymsDefine acronym at first use:

Hypertext Markup Language (HTML) was never intended to be a common programming language. The original assumption was that most word processing applications would automatically generate HTML code.65Technical Writing Biased Lang.Avoid sexist or culturally insensitive diction:

Question:Which pronoun should you use: he, she, they, one or it?Use an action-or role-based noun instead:the userour employeesseveral contractorselectrical engineermy coworkerQuestion:When is 9.4.09?When is 6/7/10?Always write out the month:April 9, 20096 July, 201066Technical Writing Sexist Lang.How should you rewrite:An engineer should always check his work.

Engineers should always check their work.

NOT: An engineer should always check their work.67Technical Writing Plagiarism STOP PLAGIARISM68Technical Writing Plagiarism Short changing yourselfWill fail + face expulsionTurnItIn.comWord-for-Word vs. Mosaic

STOP PLAGIARISM69Technical Writing Continuum Accurate Information Promotes Clear UnderstandingSpecific Details Create InterestSpecific Details70Technical Writing Specific DetailsI saw a dog today71Technical Report Structure72Technical Report StructureThree major sections: SectionComponents1. Front MatterTitle Page, Abstract, Table of Contents2. BodyIntroductions, Qualifications, Methodology, Analysis, Discussion, Conclusion3. End MatterBibliography, Appendices, Glossary73Report Front Matter

74Report Body

75Report End Matter

76

Workshop Recap The Writing & Communication Center210 Morton; Mon-Fri 1-5pmFree any SIT course, any semester

Rhetorical Triangle & Writing ProcessH.E.L.P. Ethos, Logos, PathosInvention, Composition, Revision

Technical Writing ConsiderationsAudience & Tone & DictionAvoid Jargon, Idioms, EuphemismsExplain AcronymsBe Specific & Detailed77 any Questions?78