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 think that system reqmnt's should not be in the manual. The issues
of sys req's should have been addressed BEFORE they are the point of
reading the user (?) manual and the sys admin or purchaser should have
looked and considered this issue when they were evaluating the
product.
The exception to this would be to place it in the troubleshooting area
if some of the user problems are caused by not meeting these
guideines.
<My employer mentioned including system requirements and customer
specific information but I am not sure those types of information
should be included. Any feedback would be greatly appreciated!>
Not in this order?
<Logging On
Logging Off
Screen Components
Navigation
How to use the online help provided
Overview information of the system components.>
good luck!
Bill Paine
Lanier Worldwide
______________________________ Reply Separator _________________________________
Subject: Getting Started Manual
Author: Lisa Depenbrock <lisa -dot- depenbrock -at- US -dot- FICSGRP -dot- COM> at $INTERNET
Date: 9/11/98 10:44 AM
Hello all,
I may have to write a getting started manual for my company's internet
banking system. As I have never written one before, I wanted to get
some feedback about what type of information it should contain.
I think a Getting Started manual should contain information about the
following:
Logging On
Logging Off
Screen Components
Navigation
How to use the online help provided
Overview information of the system components.
My employer mentioned including system requirements and customer
specific information but I am not sure those types of information should
be included. Any feedback would be greatly appreciated!