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.
"Michael West" <mbwest -at- removebigpond -dot- net -dot- au
>> "anice wrote:
>
> > ... asone of the authors, I
> > can explain the reasoning behind this decision, as it
> > is our in-house style as well.
>
> Was the "reasoning" based on field testing,
> or prejudice and opinion?
>
All three :->
>
> But typically a user is reading only *one*
> procedure, not a bunch of them -- so the
> bold terms in that one procedure *do* stand
> out against other words in the procedure.
> Especially since it is the individual procedural
> *step* that is the working unit -- not the
> whole page. This is particularly true in online
> help.
>
If most of the items in the procedure are steps
and most of those steps contain multiple menu items
and menu names, then the point stands: there is so
much bold that any particular bold item doesn't
really stand out.
>
> > Finally, the bolding
> > often means that users will skip over often important
> > explanatory text and just pick out the bold items.
>
> That ability to scan for the key items is
> precisely what I like about the intelligent
> use of boldface. I do not want "explanatory
> text" mixed up in procedures anyway. I want
> any important general information first, and
> *then* the procedure.
>
I completely agree that large amounts of explanatory
text do not belong in a procedure. As a matter of fact,
we insist that writers only put the instructions in the
actual step, and that any necessary brief explanatory
text (such as "Do not capitalize the filename" and the
like) are on a line underneath. That is the type of
text that users can easily skip if we are encouraging
them to skip from bold item to bold item.
NEED TO PUBLISH FRAMEMAKER CONTENT ONLINE? "Mustang" is a NEW single
sourcing tool for FrameMaker that lets you easily publish your content
online. No macro language required! http://www.ehelp.com/techwr-l3
Mercer University's online MS Program in Technical Communication Management:
Preparing leaders of tomorrow's technical communication organizations today.
See www.mercer.edu/mstco or write George Hayhoe at hayhoe_g -at- mercer -dot- edu -dot-
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.