Technical Style Workshop Part 2

Technical StyleA 2-day workshop presented by Edwin HollonDecember 1 & 8, 2009Kyung Hee University – Suwon, South Korea

AccuracyAccuracy can mean the difference between success and failure in technical documentation.Non-specific language can lead to misunderstandings (best case) or create dangerous or deadly situations for readers/users (worst case).Accuracy is often subjective (level of accuracy depends on whether or not your language is understood by the audience).

AccuracyPrinciple 7: Avoid unnecessary jargonand language that is unfamiliar or unknown to your audience.Jargon –language used by a specific group that holds particular meaning for that group (often technical, but not necessarily suitable for general audiences)Bilateral probital hematomaSlang – informal, invented, arbitrary, or extravagant language (not technical) black eye, shinerUse language that fits the rhetorical situation

Exercise 7What are some situations where jargon can be useful? Match the type of language to the situation.Doctor to a patientDoctor to other medical professionals at a conference.Pilot to the control tower.Pilot to passengers.The patient has a distal radius fracture. / The patient has a broken armWe will be landing shortly. / We are making a thirty degree southeasterly approach.Notice how jargon can be used to transfer very specific information to the audience.

AccuracyPrinciple 8: Avoid using too many hedges and intensifiers.Hedges – describe uncertainty or show cautionAdverbs: usually, often, sometimes, almost, possibly, perhapsAdjectives: most, many, some, a certain number ofVerbs: may, might, can, could, seem, tend appear, suggestThere seems to be some evidence to suggest that certain differences between Japanese and Western rhetoric could derive from historical influences possibly traceable to Japan’s cultural isolation and Europe’s history of cross-cultural contacts.Be specific and confident in your writing.

AccuracyPrinciple 8: Avoid using too many hedges and intensifiers.Intensifiers – show assertiveness, but can be overly confident or even inaccurateAdverbs: very, pretty, quite, rather, clearly, obviously, certainlyAdjectives: key, central, crucial, basic, fundamental, majorVerbs: show, prove, establish, as you can see, it is clearFor a century now, all liberals have argued against any censorship of art, and every court has found their arguments so completely persuasive that not a person any longer remembers the opposing arguments.Don’t be overly aggressive in your writing.

Exercise 8What are the hedges and intensifiers in these sentences? How can you make the sentences clearer?On the other hand, we can perhaps point out that there may always be TV programming that appeals to our lowest interests.On the other hand, TV programming often appeals to our lowest interests.The extremely terrible storm ripped across the bay and totally destroyed business buildings and homes when it hit shore. The result was very disastrous: so much wreckage, so many helpless people, so many lost dreams. To see it was really disturbing.The terrible storm ripped across the bay and destroyed business buildings and homes when it hit shore. The result was disastrous: wreckage, helpless people, lost dreams. To see it was disturbing.

AccuracyPrinciple 9: Avoid noun stacks.Noun stack – three or more nouns in a row; common in technical terminologyinformation processing behaviorcomputer human cognition simulationLong strings of nouns can be difficult for readers to “unpack.”Translating noun stacks can be difficult or, in some cases, impossible.Noun stacks often include nominalizations.Unpack noun stacks by inserting prepositions and articles and eliminating nominalizations.

Exercise 9What are the noun stacks in these sentences? How can they be rewritten?The plant safety standards committee discussed recent air quality regulation announcements.The committee that is responsible for safety standards in the plant discussed the recent announcements about regulations regarding air quality.Enforcement of guidelines for new automobile tire durability must be a Federal Trade Commission responsibility.The Federal Trade Commission must be responsible for enforcing guidelines to ensure the durability of tires on new automobiles.

Review: AccuracyJargon affects accuracy if the audience is unfamiliar with the terminology you use.Technical jargon can either exclude or include readersSlang is almost always inappropriate for technical documentationUse the terminology that best fits the rhetorical situationUnnecessary hedges and intensifiers can weaken technical documentation.Hedges can show caution or lack of confidenceIntensifiers can be too aggressive and may be inaccurateTo make your writing accurate, write confidently but don’t exaggerate or make false claimsNoun stacks can hide your intended meaningThree or more nouns in combination is a noun stackNoun stacks put a burden on the reader and are often difficult to translateUnpack noun stacks by using prepositions and articles; eliminate nominalizations

Negative vs. Positive LanguagePrinciple 10: Change negatives into affirmatives.When you use negative language, readers must mentally convert the language to understand what they should do. Negative language also requires extra words in many cases:same  not differentNegative language often describes the opposite of the action you want your audience to perform:Do not write in the negative.  Write in the affirmative.Tell your readers exactly what they should do by using positive (affirmative) language.

Exercise 10How can these expressions be changed from negative to affirmative?not different not the same not allow not many not often not stop similardifferentpreventfewrarelycontinue

Negative vs. Positive LanguageSome verbs, prepositions, and conjunctions describe negative situations.Verbs: preclude, prevent, lack, fail, doubt, reject, avoid, deny, refuse, exclude, contradict, prohibit, barPrepositions: without, against, lacking, but for, exceptConjunctions: unless, except whenWhen you combine one of these words with not, readers can easily misunderstand your intended meaning.Except when applicants have failed to submit applications without documentation, benefits will not be denied.You will receive benefits only if you submit your documents.

Exercise 11First, eliminate the nominalizations and passive voice. Then, change the negatives into affirmatives.There should be no submission of payments without notification of this office, unless the payment does not exceed $100.Do not submit payments if you have not notified this office, unless you are paying $100.If you pay more than $100, notify this office first.

Commonly Misused WordsAll writers make usage mistakes from time to time. Mistake in usage occur for different reasons:Homonymsthey’re, their, thereit’s, itsMisunderstood meaningsdiscrete vs discreetcontiguous, continual, continuousDifferent meanings in different contexts or languages (slang or invented definitions)ridechillCommonly misspelled or unintended usagelose vs loosepast vs passed

Exercise 12Choose the correct word to complete the sentence (complete the exercise in your workbook).Loose or Lose?Do not _______ the money Sarah gave you.Someone needs to catch that ______ dog.Put the _______ papers in your notebook.Did the Bulldogs _______ by many points?Affect or Effect?How did that last test ________ your grade in history?Regular study habits usually have a positive _______ on a grade.Accept or Except?I will _______ all of your terms.Everyone _______ Adam will be able to come to the meeting.He will go to the ceremony to _______ the award.

Commonly Misused WordsQ: How do I (ensure/assure/insure) that I use the appropriate word in my writing?A: Use a style guide

Style GuidesStyle guides improve accuracy and consistency.A style guide can help multiple writers who are creating numerous documents use the same voice.Style guides define terms, rules, occasions for use, and exceptions.Style guides represent the common language and culture of a company, industry, or group.They can also describe document layouts, proper use of design elements, and official guidelines for representing company brands and trademarks.Many global organizations create image guidelines to dictate how their product and brand names should be used by company personnel, subcontractors, partners, and the media.

Style GuidesTypes of style guides:General – general guides cover basic grammar rules for common types of writing, such as creating college essays.The Elements of Style (Strunk and White)A Writer’s Reference (Diana Hacker)Domain-specific – style guides developed for particular domains help writers (and readers) speak a common language and conform their writing to academic or industry guidelines.The Chicago Manual of Style (journalism)Publication Manual of the American Psychological Association (psychology and other medical fields)

Style GuidesTypes of style guides:Company-specific – a company’s style guide helps authors create a consistent look and feel for the company’s documents. This type of style guide helps authors reinforce the company’s image and brand names.Google, Apple, Microsoft, etc.Some are adopted as domain-specific guides, such as Read Me First! (Sun Microsystems) or The Microsoft Manual of StyleCustom – custom guides can be created for any application, such as a particular project.

Exercise 13Which types of style guides might you use in the following situations?(general, domain-specific, company-specific, or custom?)Writing marketing documents for a new product line.Writing user guidance for consumer electronics.Writing a master’s thesis.Writing error messages for a software program.Writing a proposal to build a new museum.Use general guides for main grammar rules.

Use domain-specific guides for industry conventions.

Create company-specific or custom guides for projects, customers, product lines, etc.Exercise 14Which style choices would you make?Spelling:Email, email, e-mail, E-mail, emailsInternet, internet, Web, web, worldwide webonline, on line, on-lineUsage:push, pressturn, rotate, twist, spinTerminology:latch, hook, fastenerhandphone, mobile phone, cell phone, phone, product, device

Review: Style GuidesStyle guides help authors:Write accuratelyWrite consistentlyMeet audience expectations (terms, presentation formats)Meet organizational goals (branding)Style guides come in various forms: General, Domain-specific, Customer-specific, and CustomIn many situations, authors may use multiple style guides in combination.You can easily make your own custom style guide by recording your decisions about spelling, usage, terminology, and design.

Technical Style Workshop Part 2

More Related Content

What's hot (17)

Similar to Technical Style Workshop Part 2 (20)

Recently uploaded (20)

Technical Style Workshop Part 2