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: Using "Tip" and "Note" in procedure writing From:"SHIELDS,SUSAN (HP-FtCollins,ex1)" <susan_shields2 -at- hp -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 1 May 2001 12:32:15 -0400
In reference to using "Tip" and "Note" in procedure writing, Christian
Walter said:
>My view is that the difference between the labels "tip" and "note" and
>"information," et al, might be too subtle to be meaningful for the average
>user.
<snip>
>Anyone know of any studies or other data I can show my cohorts here?
Where's your audience analysis? The most useful approach would be to find
out what your "average users" get out of the documentation. We on the list
can give you anecdotal data and maybe point you to a study or more formal
data but the most pertinent information will come from your own interactions
(whether casual or studied) with your users. *That* data ought to carry a
lot of weight with your cohorts, too.
Susan
-----Original Message-----
From: Walters, Christian (CCI-Atlanta)
[mailto:Christian -dot- Walters -at- cox -dot- com]
Sent: Tuesday, May 01, 2001 9:40 AM
To: TECHWR-L
Subject: Using "Tip" and "Note" in procedure writing
Hi all.
This is probably another question that gets answered all the time around
here, but I had little luck with the archives.
We're still re-working our style guide around here, and we have a bunch of
standards for "tips" and "notes" and "examples" and "important information"
and "cautions" and "warnings," etc.
My view is that the difference between the labels "tip" and "note" and
"information," et al, might be too subtle to be meaningful for the average
user. My solution is to not use those words at all, but replace it with a
word or short phrase that is more descriptive of the actual information --
such as "Prerequisite" or "Admins Only" or whatever.
And, as usual, I am meeting resistance :)
I remember Jared Spool (I think) talking about this kind of thing at the
conference in Anaheim. But I can't find it in the Proceedings. Anyone know
of any studies or other data I can show my cohorts here? I have yet to
brainwash them into simply having blind faith in me :)
Thanks!
=====
Christian Walters
christian -dot- walters -at- cox -dot- com
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
---
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.
