Re: Need your Help

["Peter Ring, PRC" <prc -at- ISA -dot- DKNET -dot- DK>]

"Parker, Cassandra M. (EXCH)" wrote ...

> One of my bosses indicated they needed a Reference Guide while another
> said they didn't want a Reference Guide but wanted a Step-By-Step
> procedure.
>
> I'm starting to get a bit confused.
>
> I know what most of the following consist of because I have the book,
> The Elements of Technical Writing but I would like to be able to see
> sample of different types.
>
> Reference Guide
> Step-By-Step procedures
> User Manual
> System Manual
>
> Thanks for your assistance and direction.

There are basically two kind of manuals: Tutoring manuals and
reference manuals.

- Tutoring manuals has the aim to teach the users how to use the
  product. This is most often done by means of step-by-step
  procedures.

- Reference manuals has the aim to act as a "brain prostetis" or
  "information bank" for what the user can't remember by heart. They
  may or may not include step-by-step procedures, depending of the
  subject.

Short manuals are often called guides. A "user manual" or "system
manual" will often be a combined tutorial and reference manual, but
there are no general standards at all for names.

The subject is covered in much more details i my book, for more
info see the web address below.

Greetings from Denmark

Peter Ring
PRC (Peter Ring Consultants)
- specialists in user friendly manuals and audits on manuals.
prc -at- isa -dot- dknet -dot- dk
http://isa.dknet.dk/~prc/
- the "User Friendly Manuals" website with links, bibliography, list
  of prof. associations, and tips for technical writers.

	http://www.documentation.com/, or http://www.dejanews.com/