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: Task-based versus UI-based documentation From:"Sweet, Gregory (HEALTH)" <gregory -dot- sweet -at- health -dot- ny -dot- gov> To:"Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>, 'TechWR-L' <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 7 Aug 2014 12:24:06 +0000
Task-based every time. If a customer asks for UI-based we might do a general lay-of-the-land type piece, but otherwise convince the customer why they really want task-based.
We are dealing with a user community that is mandated by law to use our products. A lot of our tools are for use in extreme or emergency situations, and therefore used infrequently. Our users do not want to know what every button or interface element does. And they certainly don't want to read about them all and then figure out from that how to do what they need to do. They want exactly the steps they need to accomplish the task now.
For any of our CBRNE/Severe Weather Event preparedness and response applications used as part of Incident Command Systems (ICS) we create Job Action Sheets (JAS). A JAS succinctly list the steps necessary to complete a specific job. There may be several tasks on one JAS. The idea is that you can take anyone, literally anyone, hand them the JAS and with little or no training, they can be proficient in the job. Since so much of our work is related to ICS most of our documentation ends up looking and feeling like a JAS, even if it happens to be called something else.
Cheers!
Greg
> -----Original Message-----
> From: techwr-l-bounces+gregory -dot- sweet=health -dot- ny -dot- gov -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+gregory -dot- sweet=health -dot- ny -dot- gov -at- lists -dot- techwr-l -dot- com]
> On Behalf Of Cardimon, Craig
> Sent: Thursday, August 07, 2014 8:00 AM
> To: 'TechWR-L'
> Subject: Task-based versus UI-based documentation
>
> On another forum I frequent, many of the projects discussed are required to
> follow the UI. For example, each tab of the home page is a topic.
>
> I believe the members of this forum advocate task-based documentation,
> but I thought I'd ask:
>
> What method do the TechWhirlers prefer: Task-based or UI-based
> documentation?
>
> Personally, I do things in a UI-based manner because that is what my clients
> want.
>
>
>
> Cordially,
>
> Craig Cardimon | Technical Writer
> Marketing Systems Group
>
>
> Information contained in this e-mail transmission is privileged and
> confidential. If you are not the intended recipient of this email, do not read,
> distribute or reproduce this transmission (including any attachments). If you
> have received this e-mail in error, please immediately notify the sender by
> telephone or email reply.
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Read about how Georgia System Operation Corporation improved
> teamwork, communication, and efficiency using Doc-To-Help |
>http://bit.ly/1lRPd2l
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as gregory -dot- sweet -at- health -dot- ny -dot- gov -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources
> and info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public email
> archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
