Re: Examples of good tech writing?

Subject: Re: Examples of good tech writing?
From: Bryan Sherman <bsherm -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Sat, 14 Jan 2006 17:45:39 -0500

Well, there is often discussion on this mailing list that Tech Writing
is more than just software (my area). In that spirit my choice is a
little off the wall, but I was definitely inspired by it.

"I'm Just Here for More Food: Food x Mixing + Heat = Baking" by Alton Brown.

He takes a very broad subject (baking) and comes up with a very good
organizing "gimick" (Mixing Method).

In addition he uses formatting very effectively to convey information,
and has a nice feature of a fold out that covers the basics of each
mixing method, so that the quick reference for that method is
available to all of the recipes in that method.

I also think he uses a nice mix of humor with the instructions. Humor,
as stated, can be a risky proposition, but I think it pays dividends
for him.

Bryan

On 1/10/06, R D <jaguarjam -at- yahoo -dot- com> wrote:
> Dear List,
>
> Do you have a particular book, website, or instruction
> manual that you think really captures excellent
> technical writing? I'm returning to technical writing
> after a long absence and want to get inspired.
>
> Thanks!
> Rich D.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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


References:
Examples of good tech writing?: From: R D

Previous by Author: Re: Friday Poll Idea (WAS: In love with a word)
Next by Author: Re: Read only dialog box
Previous by Thread: Re: Examples of good tech writing?
Next by Thread: Re: Examples of good tech writing?


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


Sponsored Ads