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.
On line help documentation - looking for examples and ideas
Subject:On line help documentation - looking for examples and ideas From:"Carey Jennifer (Cry)" <jennifer -dot- carey -at- cdi -dot- cerberus -dot- ch> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 23 Aug 2001 11:31:40 +0200
Hi All,
We have decided to add an online help doc to our software and to have the
actual work done by an external company. I wrote the User's Guide and the
external company is currently creating a book based on what I've written.
I've been asked to verify the "quality" and "usability" of the document when
version 1 is delivered in a few weeks. The goal is that I will eventually
take over the managment of future OLH projects completely once the process
is more fully understood (not writing it, but planning and evaluating it).
I've done a lot of reading and research on the big-picture side of OLH and
"usability", and I've also got a basic understanding of the actual process
of creating the docs. What I'm really interested in doing now is looking at
some examples of excellent work. I tried doing some search-engine research
to find these but "on line" and "help" are such general and common terms
that my research has been pretty fruitless thusfar.
Is anyone else aware of where I might find something like this? Are there
perhaps contests out there that I'm not aware of?
*** 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
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. 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.
