TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: a quick lecture on technical writing From:Marg <mkrupp128 -at- yahoo -dot- com> To:Becca <becca -at- di -dot- org> Date:Sun, 1 Sep 2013 21:16:50 -0400
I'd start with audience (who will read this report), objective (what do you want them to be able to DO with this info), organization (what's the best order that will help them do this?), and presentation (use of executive overview, summary, headings, lists, even pull-quotes when appropriate) to help them readily access the information.
Sent from my iPhone
On Sep 1, 2013, at 11:45 AM, Becca <becca_price -at- yahoo -dot- com> wrote:
> 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 mkrupp128 -at- yahoo -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.
