Other Forms of Technical Writing
Other Forms of Technical Writing. EMAIL. DEFINITION. I. DEFINITION. EMAIL : internal or external written to someone within or outside your company informal written for speed speed of writing, of delivery with formal attachments. GENERAL GUIDELINES. II. GENERAL GUIDELINES.
Other Forms of Technical Writing
E N D
Presentation Transcript
I. DEFINITION EMAIL: • internal or external • written to someone within or outside your company • informal • written for speed • speed of writing, of delivery • with formal attachments
II. GENERAL GUIDELINES 1) PURPOSE: • You should show a clear sense of purpose • Why are you writing? • Purpose Statements • Purpose Statements • Implied vs. Overt (announce) • Letter • “As you requested yesterday, ….” • Memo: • “This memorandum will….”
II. GENERAL GUIDELINES 2) READER ANALYSIS: • Know your readers’ needs • Know their technical levels • Planning Form
II. GENERAL GUIDELINES 2) READER ANALYSIS: • Whom you are trying to inform or influence influences your – • vocabulary • argument • tone • Multiple Readers/Complex Audience: • = varied audience (regarding technical skill level) • (1) reduce the level of technicality or • (2) write different parts for different readers
II. GENERAL GUIDELINES 3) FORMAT: • Pay attention to correct formats • Guidelines • Employ Email Etiquette • Follow company guidelines • for uniformity
II. GENERAL GUIDELINES 3) FORMAT • Copy: • usually a “send” option • CC = carbon copy • Abbreviation + Name of person/s receiving the copies
II. GENERAL GUIDELINES 3) FORMAT • Postscripts: • last item (used but occasionally) • PS or P.S.
II. GENERAL GUIDELINES 4) ABC Format: • ABSTRACT • BODY • CONCLUSION • (see the “Specific Guidelines” below)
II. GENERAL GUIDELINES 5) 3 C’s STRATEGY of PERSUASION: • CAPTURE • CONVINCE • CONTROL
II. GENERAL GUIDELINES 5) 3 C’s STRATEGY of PERSUASION: • CAPTURE • Capture interest with a good opener • Tell readers what the letter/memo can do for them
II. GENERAL GUIDELINES 5) 3 C’s STRATEGY of PERSUASION: • CONVINCE • Convince the reader with supporting points • Evidence supports opening claim: • this document will make their lives easier
II. GENERAL GUIDELINES 5) 3 C’s STRATEGY of PERSUASION: • CONTROL • Control the closing • Use a statement that • puts you in the position of following up on the letter/memo • and solidifies your relationship with the reader
II. GENERAL GUIDELINES 6) “YOU”: • Focus on the reader • Anticipate & answer questions the reader may raise • “How will this affect the cost? By allowing….” • Replace “I” & “me” with “you” & “your”
II. GENERAL GUIDELINES 7) ATTACHMENTS: • Email = brief • Detail = in the attachment • keeps the focus on the main point/message • doesn’t distract, avoids clutter • details = for future reference
II. GENERAL GUIDELINES 8) DIPLOMACY: • Be tactful • persuade & entice, don’t command • be mindful of your TONE & DICTION • don’t be pushy, 1-sided, condescending • Positive (good news) letters = • in the active voice • Negative (bad news) letters = • in the passive voice
II. GENERAL GUIDELINES 9) EDIT-PROOFREAD: • Errors = obvious in short pieces • Grammar – • missing or improper punctuation • faulty subject-verb agreement • faulty pronoun-reference agreement • “sexist” language
II. GENERAL GUIDELINES 9) EDIT-PROOFREAD: • Mechanics – • spelling errors • old or wrong address • wrong title, job title
II. GENERAL GUIDELINES 9) EDIT-PROOFREAD: • Style – • negative tone • no negatives: don’t, won’t, cannot • clichés & pat expressions • “per your request” • long, windy sentences • presumptive phrases • “thank you in advance”
II. GENERAL GUIDELINES 10) QUICK RESPONSE: • Written & sent within 48 hours • Give plenty of time for an appropriate response from readers • Examples – • follow-up letter to meeting • customer request on a product • service or shipping delay
III. SPECIFIC GUIDELINES 1) APPROPRIATE USE of EMAIL: • Don’t send too quickly
III. SPECIFIC GUIDELINES 1) APPROPRIATE USE of EMAIL: • (advantages) • speed • receipt confirmation • quick reply • cheap to use • cheap to send multiple copies & attachments • saves time • less formal
III. SPECIFIC GUIDELINES 1) APPROPRIATE USE of EMAIL: • (disadvantages) • not private • less formal
III. SPECIFIC GUIDELINES 2) ABC Format for EMAIL : • ABC • Abstract – • casual, friendly greeting • if justified by your relationship • introduction of your purpose • Purpose Statement • short, clear • summary of your main points • list of main topics covered • 1-2small paragraphs
III. SPECIFIC GUIDELINES 2) ABC Format for EMAIL : • ABC • Body – • supporting data • short paragraphs, with deduction • main point = 1st • headings & lists • abbreviations & jargon • ONLY when understood by ALL readers
III. SPECIFIC GUIDELINES 2) ABC Format for EMAIL : • ABC • Body – • lists to break-up the text • headings to break-up the text, divide info • personal names • names of readers • paragraphs = Deduction • General Specific • main point = 1st
III. SPECIFIC GUIDELINES 2) ABC Format for EMAIL : • ABC • Conclusion – • summary of main point • summary of your main idea, purpose • clear statement of what will happen next • Reader Analysis and Firsts & Lasts
III. SPECIFIC GUIDELINES 3) Standard “MEMO” Format: • date, to, from, subject 4) One Main Subject: • one main subject per email • state clearly, concisely, specifically • in the Subject Line • describe the point in the Body
III. SPECIFIC GUIDELINES 5) Positive Conversational Style: • use “good taste” • fragments & slang = permissible • IF they are in good taste • watch your tone • not angry, negative • constructive exchanges only
III. SPECIFIC GUIDELINES 6) Message = Context: • Why are you writing? • if in reply • “send with receipt” or • with a copy of the original • also, summarize the original 7) Appropriate Method of Reply: • reply to short message: at the start • reply to long, complex message: • one point at a time (headings)
III. SPECIFIC GUIDELINES 8) Careful Format: (page design) • headings • bulleted lists • white space • separators
III. SPECIFIC GUIDELINES 9) Chunk Information: • break into digestible, coherent chunks • one specific topic • topic, time, date, location, prerequisites, details
III. SPECIFIC GUIDELINES 10) Include Ways to Unsubscribe (groups): • give recipients a way of abstaining from future notices • show consideration 11) Suppress Recipients’ Addresses (groups): • use “bcc” (Blind Copy) line to suppress group members’ addresses • unless the group has given permission
III. SPECIFIC GUIDELINES 12) Compose in Word Processor: • check spelling & other mechanics • “cut & paste” when you’re done
IV. SUMMARY • Make wise use of ATTACHMENTS • place details in attachments • keep particulars, specifics out of these brief communiqués • Complete READER ANALYSIS • address their needs • write to their technical skill levels • follow the Rule of “Firsts & Lasts”
IV. SUMMARY • Follow the ABC Format • Abstract • Body • Conclusion • Plus the 3 C’s Strategy of Persuasion • Capture • Convince • Control
IV. SUMMARY • Have a clear PURPOSE & ORGANIZATION • Purpose Statements • ABC & #3 C’s • Planning Forms • Astutely employ PAGE DESIGN elements • Headings • Lists
IV. SUMMARY • Specific Guidelines • Appropriately Use Email • Follow the ABC Format for EMAIL • Employ Standard “MEMO” Format • Have only ONE Main Subject • Utilize a Positive Conversational Style • Message = Context • Choose an Appropriate Method of Reply • Follow Careful Page Design • Chunk Information • Include Ways to Groups to Unsubscribe • Suppress Group-Recipients’ Addresses • Compose in Word Processor