RE: a quick lecture on technical writing

Subject: RE: a quick lecture on technical writing
From: Sarah Blake <Sarah -dot- Blake -at- jdsu -dot- com>
To: Becca <becca -at- di -dot- org>, tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 2 Sep 2013 15:21:16 +0000

'Information first, explanation second.'

One of the most common things I see among inexperienced writers is a long discussion of the reasons for the decision to implement something in a certain way, followed - finally - by the description of what they actually implemented. Having to skim through a load of extraneous 'why' in order to get to the 'what' I'm looking for makes me want to throttle someone :)

Adopting this communication pattern is also really handy in other contexts, such as when asking something of a busy person who's only going to skim the first two lines of your email...

Sarah Blake
Technical Writer
Ariesoâ a JDSU Mobility Solution
Office +44 (0) 1635 232470 | Fax +44 (0) 1635 232471 |
Email sarah -dot- blake -at- arieso -dot- com | Web www.arieso.com |Â

-----Original Message-----
From: techwr-l-bounces+sarah -dot- blake=jdsu -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+sarah -dot- blake=jdsu -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Becca
Sent: 01 September 2013 16:46
To: tech2wr-l
Subject: a quick lecture on technical writing

I've been doing some technical writing for a professor at a small college in Vermont. While it's basically a military college, there are lots of civilians there too. This particular professor's students will be going into the military, into law enforcement, into intelligence (he teaches cyber forensics), into the consulting world - and therefore will be writing lots and lots of reports.

The English program at this school has one course in business writing, but it sounds like it's a pretty light-weight class - the example of some of the homework my professor friend gave me is to write a letter to a neighbor complaining about a noisy dog.

This is not going to help my friends get ready for all the report writing they're going to have to do.

My professor friend has asked me to put together a 1-1.5 hour presentation that I can give to his students about technical writing. I've got some basic rules that I like to use as my own guidelines (ABCâsâaccuracy, brevity, and clarity. 3Cs: Concise, coherent, and complete.), and I know the report format that my professor friend prefers, so I can speak to that, explain some of the things that should be in each of the sections of his suggested format. I'm also thinking about speaking about Word styles and why you should love them and use them.


What else should I include? How do you teach technical writing to a bunch of kids in an hour or an hour and a half?

Â
Regards,
Becca
_________________________
Dragons and Dreams: Bedtime Stories is now available at Amazon!
The Snarls: a Hair Combing Storyis now free at Amazon, Sony, B&N, and Kobo.
Check us out - we're at www.wyrmtalespress.com


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as sarah -dot- blake -at- jdsu -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
a quick lecture on technical writing: From: Becca

Previous by Author: Prof/Tech Communicators' Perceptions of Usage Error (Survey Invitation)
Next by Author: RE: Chapters must start on recto page???
Previous by Thread: Re: a quick lecture on technical writing
Next by Thread: Best tablet for writing/editing


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads