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.
I've recently inherited a(nother) set of Frame templates to maintain and improve.
Leaving aside various other problems I need to fix, there's been some discussion in the department about adding icons to our notes and warnings, which are currently set off from the text by a horizontal line above and below, and the text "Note:" or "Warning:" in red at the left. (I know what you're thinking, but this is unrelated to the recent "Another tragic case of not reading the manual" thread!)
I have mixed feelings about the icon issue. While they tend to make help differentiate important information from the body text, they're also sometimes considered a little juvenile. Since my audience is composed of sys admins (Unix, Linux, Win) I want to avoid having the doc immediately round-filed for falling into the "for dummies" category.
Having looked through the list archives without finding the information I seek... I was wondering if anyone out there has made a similar switch (from simple text to using icons) and if you've had positive or negative user feedback (or any user feedback) as to the effectiveness of the change.
I would be especially interested in:
1. Information from folks writing for a similar audience who have made this change.
2. Whether people using icons in their written doc are using the same (or similar) icons in their on-line help.
I guess I'm looking for anecdotal "evidence" that this is a Good Thing®. Or not.
Thanks,
Dan
"Have something to say and say it as clearly
as you can. That is the only secret of style."