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: Click X, or click the X button? From:Robert Lauriston <robert -at- lauriston -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 23 Oct 2009 08:46:05 -0700
Yeah, I've spent a lot of time rewriting uninformative
pseudo-documentation that's nothing but a narrative of the user
interface.
On Fri, Oct 23, 2009 at 8:20 AM, Chris Despopoulos
<despopoulos_chriss -at- yahoo -dot- com> wrote:
> ... It's horrible documentation that describes how to use the controls, but doesn't provide the context or meaning of the controls. I know how to pull a lever. Does the lever operate the transmission or the brakes? I don't need to know how to type in a text box. I need to know what the effect of my string will be, and what other strings must already be specified before this one will make sense. I need to tie the GUI and the processing machine to my real-world needs. I need to do it quickly and efficiently.
> </rant>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-