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: User vs. Reference From:John McDermott <jjm -at- JKINTL -dot- COM> Date:Thu, 2 Feb 1995 09:04:40 PST
>In-Reply-To: Re: User vs. Reference, From: John McDermott <jjm
>John - Thanks for contributing the definitions for User vs. Reference
manuals,
>however, I believe that the classifications limit our ability to serve our
>users. Any form of communication - manual, handout, on-line file,
>etc. - should contain any information (concepts or procedures) that the
>user needs to complete their task. If you establish the criteria for a
manual
>based on traditional methods rather than the users' needs, you
automatically
>limit the usability of the manual. - George
George,
First, how does the dictionary/textbook distinction limit our ability to
serve users? In fact, this seems to be a well known paradigm to which users
can relate.
If every manual contained "any informaiton...the user needs to complete
their task", then the dictionary should also be a grammar handbook--which
would mean that every book on, say, the English language, should be a
dictionary, thesaraus, grammar handbook, etc.
No, rather, I think manuals should follow the evolution of books, magazines,
and software: one purpose - one book (with a Master Index, PLEASE!). Just
as no one English language book can meet all my (a user) needs, niether can
a single manual.
In my earlier letter I used the example of the UNIX manuals. I chose these
because the USERS wrote these manuals, not some other staff. The manuals
were written by and for users. The general format (if not the content) has
proven very useful. [ I must admit that nowadays some of the manuals are
overly verbose and often inacurate, but then that is true of most software
documents these days, but the reasons for that are a whole different
topic...]
Let's keep this going. As a tech writer and a technical manual user this is
of major importance to me.
--john
-------------------------------------
Name: John McDermott Author and Consultant
E-mail: jjm -at- jkintl -dot- com (John McDermott)
Voice: +1 505/377-6293 FAX: +1 505/377-6313
