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:ReadMe files, License agreements From:Debra Graham <dgraham -at- AECSOFT -dot- COM> Date:Tue, 6 May 1997 18:55:17 -0400
Hi,
I'm working on documenting a schedule software package that runs on
Windows and Macintosh and have some questions about writing installation
instructions.
The User Guide contains instructions for installing a single-user copy
of the product. The Network Essentials Guide contains instructions for
installing the product on a network?the audience for this guide is the
network administrator. Unfortunately, the User Guide has already gone
to print so I can't change the installation instructions in it--but I
can still change the Network Essentials Guide.
Specifically, what I'm wondering is if, in the step-by-step procedures,
I should
? describe what a ReadMe file and tell the administrator to read the
ReadMe file before clicking OK to the next step
? tell the administrator to review the license agreement before clicking
the Accept button.
I looked at the installation instructions for several other software
packages to see if their instructions were that explicit and didn't find
any that said to read the license agreement and only a couple that said
to read the ReadMe file before continuing. Some instructions do
describe the ReadMe file elsewhere and say to read it. I'm not sure how
explicit to be??it might irritating to the network administrator and
make the instructions look longer and more complex; on the other hand,
maybe they need to be directed to do these actions.
Does the audience make a difference??in other words, would you include
the instructions for the end user but not for the network administrator?
Thanks in advance for any feedback,
Debra Graham
--
Debra Graham
Documentation Manager
AEC Software, Inc.
<<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>>
22611-113 Markey Ct. work email: dgraham -at- aecsoft -dot- com
Sterling, VA 20166 school email:
grahamd -at- gusun -dot- georgetown -dot- edu
(703) 450-1980 ext. 3009 http://www.aecsoft.com
(703) 450-9786 (FAX)
<<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>><<?>>
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
