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: another twist for instructions From:"Dave Whelan" <dwhelan -at- qnx -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 12 Mar 2001 13:00:01 -0500
Mike writes:
> Over the years, I've seen several software manuals that
had a section
> right at the beginning called something like "Read This If
You Don't Read
> Manuals." It usually contained the essentials, boiled down
for people who
> want to learn by trial and error instead of reading. I've
always wanted
> to include a section like that in my own docs, but haven't
been certain
> enough of its usefulness in my projects to take the
plunge...
>
Multi-level information can be useful throughout a book,
especially if you are trying to reach users with a wide
range of expertise. For many procedures, experts might
breeze through using one-liners, less advanced users might
need a bit more background, and novices might need
tutorials. It's easy to serve the needs of a range of users
in online docs, because anything unnecessary can be hidden
unless requested; it's not so easy when you're trying to do
it in one paper doc though.
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
---
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.