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: Coordinating Field Defs and Procedural Info From:"Hickling, Lisa (TOR)" <lhickling -at- Express-Scripts -dot- com> To:"Diane Boos" <dianeboos -at- comcast -dot- net>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 6 Nov 2006 10:37:26 -0600
Thanks for your input especially concerning due regard for advanced
users, Diane. I agree, once users are familiar with definitions they
are interested mainly in reminders on which parameters to enter, screen
behaviours, exceptions, etc but not definitions.
Lisa. H.
-----Original Message-----
From: Diane B.
I've done both ways. I prefer giving the definitions prior to the
procedure if adding the definitions make the procedure long and
complicated, or if the definitions break the continuity of the procedure
flow.
...
Another good reason for having all the text separate from the steps is
for the advanced user. Once people are familiar with the parameters,
they can skip to the steps and not weed through the text every time they
use the procedure.
That help?
Diane
******* Confidentiality Notice *******
ESI Canada -- Optimizing the value of drug and dental benefits
This email, its electronic document attachments, and the contents of its website linkages may contain confidential health information. This information is intended solely for use by the individual or entity to whom it is addressed. If you have received this information in error, please notify the sender immediately and arrange for the prompt destruction of the material and any accompanying attachments.
******* Avis de confidentialite *******
ESI Canada -- Optimiser la valeur des regimes d'assurance medicaments et dentaires
Ce courriel ainsi que tout document y etant joint de meme que le contenu des liens vers des sites Web peuvent reunir des renseignements confidentiels sur la sante. Cette information s'adresse uniquement a l'usager ou a l'organisation auxquels elle est destinee. Si vous avez recu ce message par erreur, veuillez en aviser l'expediteur immediatement et proceder a la suppression du document et des fichiers joints sans tarder.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-