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.
RE: Which style of giving instructions is more effective?
Subject:RE: Which style of giving instructions is more effective? From:Kelley Walker <kelley -dot- walker -at- libtax -dot- com> To:"techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 20 Dec 2012 13:51:00 +0000
Out of curiosity, does anyone know if there is any research on the topic? The OP asked for the "more effective" style. Were it me, I'd want to know what actually works, under what conditions, and why.
I'm doing UX work right now, but a heavy component is content - getting instructions right, setting standards and style guidelines. Instructions are common throughout the application. I've been following the approach I was taught, "To use your current account, do X," especially since there's often a lot of technical verbiage that the SMEs want to stay in for legal and due diligence reasons.
While we have headings, when we did usability testing on this issue, we found that the bulk of our users completely ignore headings. I call it heading blindness.
This electronic communication and any files transmitted with it, or attached to it, are confidential and are intended solely for the use of the individual or entity to whom it is addressed and may contain information that is confidential, legally privileged, protected by privacy laws, or otherwise restricted from disclosure to anyone else. If you are not the intended recipient or the person responsible for delivering the e-mail to the intended recipient, be advised that you have received this e-mail in error, and that any use, dissemination, forwarding, printing, or copying of this e-mail is strictly prohibited. If you received this e-mail in error, please return the e-mail to the sender, delete it from your computer and destroy any printed copy of it. Although our company attempts to sweep e-mail and attachments for viruses, it does not guarantee that either are virus-free and accepts no liability for any damage sustained as a result of viruses.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: Create 10 different outputs with Doc-To-Help -- including Mobile and EPUB.
