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.
First of all, apologies to say that I do agree with
your management's view of a user without IT exp being
able to install the application based on the
Installation Guide.
I have come across installation guides in the
companies I have worked for, for Enterprise
applications. It is a bit strange if your client has
to take a third party's help in order to set up the
application your company has developed. So, I fully
agree that the installation guide u would be writing
should contain detailed and precise information about
the installation.
In addition to that, u can also add a troubleshooting
section at the end as an appendix to the installation
guide. Input for this section can come from various
sources in your organization such as : QA, Bug
Tracking software, a generous developer :-), Technical
Support staff (these guys would be able to give u the
actual scenarios faced by clients), and of course,
problems u might have come across when u tried to
install the Enterprise Application.
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.