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.
Yes, use the heading to declare what you're about to present. No need to
repeat it in the body text.
"Minimalism", if you will.
But more than that, it avoids breaking traditional grammar rules about using
fragments. Not that that is the most important thing. No -- the most
important thing is brevity and clarity.
You people have to understand that among your readers are people to whom
traditional rules still matter. You'd better be across that if you claim to
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Arnold, Ann
Sent: Tuesday, October 18, 2011 8:51 AM
To: Becca; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: introducing steps
After taking JoAnn Hacko's course, "Minimalism: Creating Manuals People Can
Use," based on user tests and research, I'd do away with intro sentences all
together whenever possible. Just use the Heading ...
To Add a Gadget to the Widget (heading or subheading)
1. Navigate to the blah blah
2. Select the blah blah from the blah blah
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-