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 am writing instructions for tasks to go into a user manual. The software
has two methods for creating customers.
One method is to create a customer using Customer Management.
The other is via a Quick Customer creation utility. This utility opens
whenever a users clicks a button in other functional areas.
Both are quite long procedures involving many sub-tasks.
1. Should I include the Quick Customer creation within the Customer
Management chapter of the manual or within the chapters for each of the
applications?
If I include Quick Customer creation in the Customers chapter should I
repeat the details of all the step or cross reference to the existing
material? The software layouts are different but a lot of the functionality
is identical.
2. As the Quick Customer utility is only available in the other applications
should I include it in these alone. If so, should I include it complete with
all details in every chapter or once and cross reference.
I believe users will work in only one functional area and therefore read
only the manual sections referring to that area. So I'm leaning towards 2
with the steps complete in each area, but the repetition bothers me.
Tel: +357 2 719500
Fax: +357 2 349276
e-mail: claire -dot- philpott -at- alphanova -dot- co -dot- uk
www.alphanova.co.uk
alphapartner: Software for Business Community Management
This e-mail message and any files attached are for the sole use of the
intended recipient(s), are confidential and may contain privileged
information. Any unauthorised review, use, disclosure or distribution is
prohibited. If you are not the intended recipient, please contact the
sender by reply e-mail immediately and destroy all copies of the original
message. Alternatively send an e-mail to our administrator at
postmaster -at- alphanova -dot- co -dot- uk
*** 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.
