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: Installation guide for Enterprise application From:bcliver -at- manu -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 31 Aug 2004 08:37:57 -0400
Hi Shelly,
Yes, it's reasonable to expect users to install, configure, and
troubleshoot their own enterprise software because cost constraints demand
it.
However, you should say up front that before installing, users must have a
strong knowledge of their operating system, including registry functions,
setting environment variables, and editing configuration files (or some
similar wording). If your enterprise suite requires a database, then
recommend that a dba participate in the creation or migration. Include a
section listing prerequisite hardware, software, network requirements, and
so forth. Add a section on verifying a successful installation.
Do not write an installation doc with 99 steps. Break it up into smaller
pieces with links telling installers where to go next. Not all steps apply
to all installations, so you'll need to be creative in guiding installers
to the next logical step. For example, a step may be necessary on UNIX but
not Windows.
>I work for a company developing an complex enterprise application that
integrates with several other systems >including databases and CRM
systems. Most people in the company expect to be able to install and have
the software >running in 30 minutes or less and because that's not
possible, are asking for an overhaul of the installation >guide. My
viewpoint, from having worked at other enterprise application companies,
is that installation for these >systems are a tricky business and usually
are implemented by professional services, offering a generous revenue
>stream for the company. Others in the company, including product
management, disagree saying that customers should >be able to read the
documentation and install and integrate this on their own with no IT
experience. I'm the only >writer in the company and am looking for some
industry comparisons that I can take back to product management to >help
set their priorities. They are basing all of their assumptions off of
internal users and won't consider going >to customers for a needs
analysis.
>Does anyone else out there work on enterprise applications? Do you offer
an installation guide? What assumptions do >you make regarding the user
experience? Any information is greatly appreciated.
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.
