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:Summary of examples of GOOD Technical Writing From:jsokohl -at- mac -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 1 Jul 2002 9:54:48
Hi all,
Well, my request for examples of really good tech writing elicted only four
responses:
* Three ?wow, great question, looking forward to your results? comments.
* One ?I?m working on an article about this topic so you can?t have my
info? response.
* And one bona fide submission. Meg said, ?For the lets-get-this-job-done
documentation, I love The Linux Documentation Project( http://www.tldp.org). Many authors, many writing styles. Content quality
varies considerably. The bottom line is that the writing is practical, to
the point, and highly on-topic.?
Thanks, Meg!
With that in mind, I?ll simply share my favorites. Most of these are Apple
related, simply because I think that, through the years, the Apple
technical writers have done a wonderful job. But that?s just my opinion.
I?ve sorted these by doc types: Discussion, Reference, and Procedure. Hope
you enjoy,
joe
PS Unfortunately, some of the URLs are really, really long. You might have
to do some cutting & pasting...
------------------------
Discussion:
Macintosh Human Interface Guidelines (one of the core HCI documents): http://developer.apple.com/techpubs/mac/pdf/HIGuidelines.pdf
WebObjects Overview: http://developer.apple.com/techpubs/webobjects/WebObjectsOverview/index.html
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Save $600: Create great-looking Help files and software demos with
RoboHelp Deluxe. Get RoboHelp and RoboDemo - our new demo software - for one
low price. OR Save $100 on RoboHelp Office in June with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
