270 likes | 346 Views
Informal Writing. > So, for those of you in the tech sector, what kind of writing do you do as part of your job?
E N D
> So, for those of you in the tech sector, what kind of writing do you do as part of your job? • “Subtle but politically charged emails and reports which will be circulated via mailing list to higher-ups that make it clear what the problem is without explicitly blaming anyone who will get hostile over it.” - Dan Johnson
> At what skills do you find your fellow colleagues sadly lacking? • “The ability to make vast wastelands of (nonetheless important!) data look formatted and attractive enough to wade through. I hate the form-over-content marketing crowd, but … people, a few headings and some table layout will make your results so much … easier to understand.” – Doug Jones
Big Blocks of Text • Frequently, the recipients of long documents, rather than analyze the entire document carefully, have a tendency to simply read the first little bit. This can be particularly true of documents sent via email. Sometimes, this syndrome can be alleviated by turning longer blocks of text into shorter lists of individual points. Even simple things like white space between list items can help draw attention to each underlying idea.
Listifying • Sometimes, document recipients just read the first bit. • This is particularly true of emails. • Putting the key points in a list can help. • Putting them in a big block of text does not. • The empty spaces between the bullet points make the list look even simpler.
Responding to an email • First questions: • How many people are getting a copy of this message? • How closely are they paying attention? • Are you responding to: • An original email? • A response to a previous email? • One of many responses to an ongoing group discussion? • How closely are youpaying attention?
The easy stuff • Simple correspondence with one other person: • Read his or her email carefully. • Respond as seems appropriate. • Be both clear and polite – if something can be misread as hostile, it frequently will be. • Email is typically brief and direct. • “Brief and direct” is easy to misread as “angry”, “dismissive”, or “insulting”.
The self-explanatory stuff • Don’t email when you’ve won or lost an argument. • Don’t email angry. • Don’t email at 2:00am. • Don’t email drunk.
Multiple-recipient email • Even if you’re just responding to one person’s statements, you have an audience. • Don’t say it in email if you wouldn’t say it in a meeting room • … where you knew you were being recorded. • The larger the recipient list, the more opportunities there are for words to be misinterpreted or taken out of context.
CC vs. BCC • Courtesy Copy and Blind Courtesy Copy • Originally stood for “Carbon Copy” and “Blind Carbon Copy” • CC list is available to all recipients • BCC list is not available to all recipients • Often used as an anti-spam measure in large lists • Preserves confidentiality • Sometimes causes problems when recipients don’t know what is or isn’t sensitive information
Top Posting: Posting a response above the original email Your response: • “Sarah’s ideas show a lot of potential. I think the additional functionality would be worth the added complexity of the UI.” Original message: >So, what do you think about Sarah’s new proposals? They’d make our product more versatile, but marketing thinks the necessary changes to the UI would make the learning curve too high for new customers.
Top Posting – worst case scenario Your response: “Sarah’s ideas show a lot of potential. I think the additional functionality would be worth the added complexity of the UI.” The (whole) original message: >Hi everyone. Great meeting today – I think we really brought up some crucial issues to address before product launch. I’d like to schedule another such meeting for Wednesday of next week. Does that cause scheduling problems with anyone else? >So, what do you think about Sarah’s new proposals? They’d make our product more versatile, but marketing thinks the necessary changes to the UI would make the learning curve too high for new customers. >Julie Wilson >Product Manager >Kobayashi, Inc. >(831)555-4857 >~~~ Great spirits have always encountered violent opposition from mediocre minds. – Albert Einstein ~~~
Bottom Posting: Posting a response beneath the original email Original message: >So, what do you think about Sarah’s new proposals? They’d make our product more versatile, but marketing thinks the necessary changes to the UI would make the learning curve too high for new customers. Your response: • “Sarah’s ideas show a lot of potential. I think the additional functionality would be worth the added complexity of the UI.”
Interlaced Posting >So, what do you think about Sarah’s new proposals? • “Sarah’s ideas show a lot of potential.” >They’d make our product more versatile, but marketing thinks the necessary changes to the UI would make the learning curve too high for new customers. • “I think the additional functionality would be worth the added complexity of the UI.”
Interlaced vs. Bottom posting • Interlaced: • Pro: • Can address individual points specifically. • Can be less ambiguous. • Con: • Can accidentally separate sections from a larger context. • Can look somewhat untidy, or difficult to read. • Bottom Posting: • Pro: • Can deliver a more cohesive overall message. • Con: • Can take longer for a reader to get to that message.
In Defense of Top Posting: • Is the recipient list a small group of people? • Are they clearly focused on the matter at hand? • Then top posting can be the most efficient type of response.
Journal-style Writing • Expositional narratives • How I solved this problem, as a drama. • Highlights real life problems and real solutions • Can help frame seemingly “technical” issues as general interest ones.
Blog Writing • Tutorial Blog Writing • “Before you start this project, you’ll need to get some basic safety equipment: a fire extinguisher, welding gloves, and some goggles. (All can be bought at your local hardware store.) • You’ll also need a roll of heavy duty duct tape ($6.95)…” • Use conversational, not formal language.
Conversational vs. Formal Writing • Formal project description "This project is to delineate what type of plants survive in specific planetary environments. For each planet, a plant will be designed. The goal is to learn what type of roots, stem, and leaves allow the plant to survive in each environment. Some hints are provided throughout the program."
Conversational project description "You are about to start a journey where you will be visiting different planets. For each planet, you will need to design a plant. Your mission is to learn what type of roots, stem, and leaves will allow your plant to survive in each environment. I will be guiding you through by giving out some hints." (Examples from Kathy Sierra’s “Conversational Writing Kicks Formal Writing’s Ass.”)
Bottom line: talk to your audience • Consider your recipient list, or potential visitors to your blog. • Showing off your advanced knowledge is good, but so is remembering and retelling your early mistakes. • Experienced readers will typically commiserate with your failures. • New readers will learn from them. • Most importantly, you can show off your learning process.
Editing Wikis • See: Wikipedia: Editing a page • Minor edits: spelling, grammar, slight formatting changes. • Not changes to content, even minor changes. • Major edits: can include changing even a single word, if that changes the entry’s content.
Major edits • Create an edit summary • Note what you’ve changed, and why • Make note of summary limitations • Example: Wikipedia has a 200 character limit. • Follow the appropriate Style Guide • If you’re changing, but not replacing, an existing entry: • Try to match the style of the previous author.