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: Getting Started Manual From:Dan Roberts <DRoberts -at- ISOGON -dot- COM> Date:Fri, 11 Sep 1998 11:04:50 -0400
Consider adding procedures for the various tasks the users will perform
- not the complicated ones, but the simple ones at least. Maybe a couple
of procedures for each screen component (or are screen components
something else? - i'm thinking menu bars or buttons or dialogs).
Also, I think i'd be wary of putting too much information in the screen
components, or navigation, or overview sections. Just hit the
high-lights and then get the user clicking and dragging and doing
something.
System requirements are fine to include. What is "customer specific
information"?
Dan Roberts
droberts -at- isogon -dot- com
-----Original Message-----
From: Lisa Depenbrock [mailto:lisa -dot- depenbrock -at- US -dot- FICSGRP -dot- COM]
Sent: Friday, September 11, 1998 10:44 AM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Getting Started Manual
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!
