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.
> From: Lisa Depenbrock [mailto:lisa -dot- depenbrock -at- US -dot- FICSGRP -dot- COM]
> 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.
It should contain the information it takes your reader to get started. And
nothing else.
We can't get more specific. We don't know your system or your target
audience.
> I think a Getting Started manual should contain information about the
> following:
> Logging On
> Logging Off
Probably. Unless the system uses a security system that the target audience
is familiar with.
> Screen Components
Only the ones your target audience is not familiar with.
> Navigation
Only if your target audience is not familiar with the navigation system.
> How to use the online help provided
Only if your target audience is unfamiliar with the help system.
> Overview information of the system components.
Perhaps. Is it necessary in order to start using the system? Is the
information available in the help system or users guide (is there one?).
> My employer mentioned including system requirements and customer
> specific information but I am not sure those types of
> information should be included.
System requirements should only be included if the target audience has
control over the system. If the target audience consists of your customers
and they will be installing the system on their own computers, it makes
sense to include system requirements. If the audience is employees within
your company and the IS department is going to set up each station, the
system requirements should be documented for IS, and that documentation
should be separate from the Getting Started manual.
---
Office:
mike -dot- huber -at- software -dot- rockwell -dot- com
Home:
nax -at- execpc -dot- com
