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: Business Process Information in a User Guide From:"Christensen, Kent" <lkchris -at- sandia -dot- gov> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 5 Sep 2001 10:03:56 -0600
re: I have been asked to include these business process maps in the user
guide.
Well, of course there are certainly concepts like prerequisite, footnote,
bibliography, etc. It happens all the time, and sometimes the material is
quoted and sometimes it's just referenced.
It's not particularly clear in the original posting, but ...
... if the company using the guide and the company prescribing the process
are the same, this is a good opportunity for posting the material on the
company intranet. Link from the user guide to the bibliography/prerequisite
process material rather than duplicating it in the user guide.
... if the processes are general and intended as examples for multiple
firms, include them in the user guide. Or don't--see below.
Actually, this situation sounds like the latter, but consider the following.
It's stated the idea came from "audience analysis," which makes it sound
like a customer request whether it was ultimately verbalized by your boss or
not. The "customer is always right" is a pretty common approach, and it
sounds like your audience analysis was quite successful in that it provided
you the direction your customers want.
Getting it accomplished is another thing, of course. Sometimes there can be
too much customer input to reasonably include it all. Your job, then, is
ranking and prioritizing. You could get more customer help with that.
Perhaps yours is a situation where training is key. That is, the product is
best used following training, and a manual can hardly ever be enough. If
that's the case, why not minimize the manual and try to sell some training
or consulting? It certainly appears like that's the approach taken by
Oracle and others. There would never be trainers or consultants if it could
always be done with a manual. Yes, each customer in your audience analysis
would like the manual customized for them, but ... there's no reason why
this should be free (see dot.bomb).
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/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.com +++
---
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.