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.
We have an installation guide for our Enterprise project, and have worked
with our own consultants to best structure it. It is presumed that the user
is of 'system administrator' level with experience working with their CMS of
choice.
We structured the guide around the physical installation requirements
(production server, web server and client installs are all required).
It does require some manual steps, but we've made as much of it Wizard based
as possible. We are similar in that it is presumed that professional
services will be used, but in an ideal world, with a generic out-of-the-box
system (ha ha) they should be able to use the installation guide. One of the
arguments I put forward to HAVE an install guide was that it helped set the
expectation for the user on the degree of difficulty they were likely to
experience. It also serves as the guide that the consultants use as the
basis for all the installations, with the caveat that it is up to them to
work around system specific issues (different port numbers for connections,
etc etc).
I would suggest that getting customer feedback and expectations for this are
crucial, can you contact any of the professional services who have been
involved in the past? I'd possibly place them as your target users of an
installation guide, and try and engage them in some discussions about what
they want/need.
HTH
Gordon McLean
Senior Technical Author
McLaren Software Ltd.
> -----Original Message-----
> 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.
>
________________________________________________________________________
This e-mail has been scanned for viruses, however, No liability is accepted for any viruses contained in this message or any of its attachments and it is the recipient?s liability to scan this message and its attachment for the same.
________________________________________________________________________
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.