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: my bad displays habit From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:"Techwr-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 2 Mar 2010 20:13:49 -0800
I'm currently in my first consumer-product gig in a verrry long time. The model
Startup dialog opens on power-up.
First instruction appears on the display.
When user makes a selection the second dialog opens.
Second instruction appears on the display.
Etc., etc., etc.
We write the instructions and create the graphics and anumations that the system
displays. No printed or CD manual other than a brief startup guide that walks
the customer through the steps needed to get the unit out of the box and plugged
The behind-the-scenes documentation required to produce this apparently
minimalist customer instruction in over 20 languages is a bigger job than any
user manual I've ever written.
----- Original Message -----
From: "Karen L. Zorn" <k -dot- zorn -at- zorntech -dot- com>
> That do-this, this-happens (or you see this) habit has continued to this
> day, some 30 years later. Yes, you can go overboard, but I'd rather have
> procedures that support the user than to leave them guessing,
> frustrated, and in the end angry with your product.
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-