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: minimalist? online help (longish and slightly theoretical-ish)
Subject:Subject: Re: minimalist? online help (longish and slightly theoretical-ish) From:"Laura A Mac Lemale" <lmaclemale -at- paychex -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 23 Nov 2001 14:39:50 -0500
Nancy, et al,
Techwr-Lers have provided some insightful comments about online help and its proper format and usage. This is just an additional two cents on the topic after reading the digest....
If I interpret minimalism correctly (and those theory classes were a couple of years ago, so... <g>), the approach for online help would be a layered one, where users of various levels can find the information they each need. The background, technical, and procedural information is all there for those who need it, and it is presented in a layered format.
The main level might be the existing help, procedural help, with links to more detailed information and/or popup definitions for those who need more system information. This approach does not fill the screen with inappropriate information for advanced users, and does not prevent novice users from navigating to more detailed information. For newer users, a screen shot might be appropriate for a topic such as
"Understanding/Navigating in the XYZ System."
For this type of approach, you might not have to change the existing help file so much as enhance it with links to more detailed information (unless, however, the help system is really lacking in useful information "as is").
Visual cues such as icons, colors, and popups used sparingly can help users distinguish between types of information (i.e., popup = definition; light bulb icon = more background information on a topic; arrow icon = "show me" application help, etc.). Also, never underestimate the importance of a glossary and an index in online help for all user levels.
Anyway, this is just one opinion. Hope the info is at least somewhat helpful.
Have a great weekend,
Laura
--
Laura MacLemale
Technical Writer, EDV
Paychex HRS Operations
(716) 336-6515
lmaclemale -at- paychex -dot- com
Disclaimer: The views expressed in this message represent those of the sender and not of Paychex, Inc.
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.
