1 / 21

The Technical Approach

The Technical Approach. Diction and Idiom. Introduction. Word choice comprises most of the work of drafting a technical document The target range for word choice varies with audience and purpose Four variables to observe are language level, diplomacy, precision, and concision.

hashim
Télécharger la présentation

The Technical Approach

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. The Technical Approach Diction and Idiom

  2. Introduction • Word choice comprises most of the work of drafting a technical document • The target range for word choice varies with audience and purpose • Four variables to observe are language level, diplomacy, precision, and concision

  3. A. Language Level and Diplomacy Diplomacy Language level

  4. IDIOMATIC EXPRESSIONS

  5. Idiomatic Expressions • Cannot be translated literally into other languages • Have one or more vague meanings that are nonetheless distinct from those of the simple words of which they are made • “put on”, “to have pull” • Are too basic a level of language in most technical documents

  6. OBSCURE VOCABULARY IDIOMATIC EXPRESSIONS

  7. Obscure Vocabulary • Is usually limited in use to a narrow domain of study or research • Accounts for a large part of English vocabulary even though most English speakers are not familiar with it • “putative”, “contumely” • Should only be included (with definitions) if suited to the subject matter and readership

  8. OBSCURE VOCABULARY INCORRECT NUANCE IDIOMATIC EXPRESSIONS

  9. Incorrect Nuance • Beyond their literal definitions, English words carry a nuance or connotation • Words or expressions with a correct definition but incorrect nuance may be undiplomatic • Imagine describing an “aggressive salesperson” to his client • For good nuances, analyze the audience and purpose of your document or presentation

  10. OBSCURE VOCABULARY PRETENTIOUS VOCABULARY INCORRECT NUANCE IDIOMATIC EXPRESSIONS

  11. Pretentious Vocabulary • Some English words in ordinary use have almost exactly the same meaning as simpler words • Inexperienced writers sometimes use these words to convey professionalism • “utilize” instead of “use” • “as per your request” instead of “as you asked” • Avoid such pretentious diction in technical communication

  12. B. Concision and Precision Precision Concision

  13. OBSCURE VOCABULARY UNDEFINED TECHNICAL TERMS UNEXPANDED TECHNICAL ABBREVIATIONS PRETENTIOUS VOCABULARY INCORRECT NUANCE IDIOMATIC EXPRESSIONS

  14. Undefined Technical Terms and Abbreviations • For exactitude, many technical documents require rather specialized words and abbreviations • “fibula” = calf bone, “URL” = universal (or uniform) resource locator • Nevertheless, readers unfamiliar with these terms may need to understand such writing • Include informal definitions (parenthetical, like this one), glossaries, or lists of abbreviations in these cases

  15. OBSCURE VOCABULARY UNDEFINED TECHNICAL TERMS UNEXPANDED TECHNICAL ABBREVIATIONS PRETENTIOUS VOCABULARY INCORRECT NUANCE COMMON ACADEMIC ABBREVIATIONS CONTRACTIONS IDIOMATIC EXPRESSIONS

  16. Common Abbreviations and Contractions • Avoid Latin abbreviations - i.e. (that is), e.g. (for example), etc., and & • Never use either “etc.” or “and so on”; only use “&” in a corporate logo or in a quote • Use contractions sparingly only in informal letters and memos (“I’m”, “she’d”, “can’t”) • “It’s” = it is; “its” (without apostrophe) = possessive of “it” • Use any common abbreviation sparingly - “I recorded MTV, CFL, and the FBI show from TV to a DVD on a PC in the LAN...”

  17. OBSCURE VOCABULARY NON-ENGLISH WORDS AND PHRASES UNDEFINED TECHNICAL TERMS UNEXPANDED TECHNICAL ABBREVIATIONS UNSTRUCTURED REDUNDANCY PRETENTIOUS VOCABULARY INCORRECT NUANCE COMMON ACADEMIC ABBREVIATIONS CONTRACTIONS IDIOMATIC EXPRESSIONS

  18. Redundancy and Preciousness • Limited repetition of information is necessary in most documents • “Structural” redundancy, for example in introductions • Otherwise, keep sentences short • In 12-point font, never more than three lines; usually less than two lines • Non-English expressions, though known, are considered overly “flowery” in industry • a la mode = “in fashion”; de rigueur = “mandatory” • Revise and edit for concision and frankness

  19. OBSCURE VOCABULARY NON-ENGLISH WORDS AND PHRASES UNDEFINED TECHNICAL TERMS UNEXPANDED TECHNICAL ABBREVIATIONS UNSTRUCTURED REDUNDANCY PRETENTIOUS VOCABULARY INCORRECT NUANCE COMMON ACADEMIC ABBREVIATIONS UNSUPPORTED SUPERLATIVES CONTRACTIONS CLICHÉ AND SLANG IDIOMATIC EXPRESSIONS

  20. Superlatives, Cliché, and Slang • Superlatives and favourable comparisons must be supported by evidence • Avoid “very”, “best”, and especially “great” to mean “excellent” - let measures such as clock speed and crash rate speak for themselves • Clichés say nothing in technical writing • “You’re going to love this application!” • Never use slang in technical documents - it lacks seriousness...

  21. Conclusion • Several revisions and significant editing are required in any technical writing • The guidelines of level of language, diplomacy, precision, and concision are reliable in this process • The best choice of words in any document depends on its audience and purpose

More Related