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: Clearing the check marks From:"Boudreaux, M (GE Healthcare, consultant)" <MadelynBoudreaux -at- ge -dot- com> To:"Michael West" <mbwest -at- bigpond -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 20 Oct 2008 12:12:10 -0400
> "What kind of work do you do?"
> "Oh, I select boxes."
In this case, you're wrong.
>But please get rid of all that selecting of boxes.
>Make your writing task-oriented.
>Make it subject-matter-oriented.
>Make it real-world oriented.
It's a series of tests. For each step, there's a box which says, in
effect (in various forms of engineer-speak, which is one issue I'm
trying to fix), "Are all the checkboxes on this page cleared? Circle YES
or NO."
This is NOT a "real world task" document. It's not even a testing
document, per se, but a document to test whether the more fleshed out
tests that are run in the field actually verify the cause of an error.
It involves a lot of detaching parts, clicking boxes, unplugging cables,
pressing buttons, attaching the parts again, plugging in the cables, and
recording results for every step.
I have to maintain a step instructing the users to do Task A, and then
to note that they have done Task A.
Even if Task A is boring, isn't task oriented, isn't real-world
oriented, and makes me drool.
I'm assured that, due to the large amounts of potentially dangerous
energy being used in these machines, some early i-dotting and t-crossing
and yes, box-checking, may mean the difference between whether a patient
comes out of surgery okay. Is that real-world enough for me? Yep.
>It is ludicrous to attribute "needs" to checkboxes on a form.
The government auditing agency disagrees, but thanks for your 2 cents.
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-