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:Tue, 27 Oct 2009 09:14:59 -0700
That sounds like you're rationalizing GUI-driven documentation using
the language of task orientation.
On Tue, Oct 27, 2009 at 4:53 AM, Chris Despopoulos
<despopoulos_chriss -at- yahoo -dot- com> wrote:
> ... Why does a dialog box need more than:
> * Synopsis (including gotchas, tips, and warnings)
> * Result (analogous to function return val, or output)
> * Inputs
> * Error states (usually unnecessary because alerts self-document errors)
>
> Then a "task" becomes something like...
> To configure your frazbot, set the following dialog boxes in the following order:
> * <link>Hinkey</link> dialog, to specify which hinkies will run during frazbot initialization
> * <link>Dinky</link> dialog, to assign the persistent hinky to the frazbot dinky state
> * etc.
>
> The *level* of task orientation jumps to a different electron orbit ...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-