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:Fwd: what to call it? From:Bill Hartzer <Highfield -at- AOL -dot- COM> Date:Fri, 3 Jan 1997 13:26:21 -0500
What determines the name of the guide/manual you're putting together?
1 - the content of it determines what it's called. if it's an
administrator's reference guide, that's what it should be called. If a
general user will read it, it's a user's guide.
2 - the purpose of the guide determines the title. What will the reader of
this information use the information to do? Will it help them USE the guide?
Is it just REFERENCE material? This goes along with #1 above.
3 - the overall tone of the guide also can determine the name of the it. If
the content is stuffy, difficult to read, and generally has textbook-type
tone to it, it should be called a MANUAL. If the content is fun to read yet
informative, it should be called a user guide or a 'GUIDE TO HELP YOU GET
THAT THING WORKING' guide.
Of course, these are MY opinions and the opinions of my company, Highfield
Marketing Group, Inc. I own the company. I can say what I want. :-)
Cheerfully,
Bill Hartzer
Highfield Marketing Group, Inc.
Dallas, Texas http://members.aol.com/highfield
---------------------
Forwarded message:
Subj: Re: what to call it?
Date: 97-01-03 13:26:06 EST
From: Highfield
To: spillman!jengler -at- UUNET -dot- UU -dot- NET
What determines the name of the guide/manual you're putting together?
1 - the content of it determines what it's called. if it's an
administrator's reference guide, that's what it should be called. If a
general user will read it, it's a user's guide.
2 - the purpose of the guide determines the title. What will the reader of
this information use the information to do? Will it help them USE the guide?
Is it just REFERENCE material? This goes along with #1 above.
3 - the overall tone of the guide also can determine the name of the it. If
the content is stuffy, difficult to read, and generally has textbook-type
tone to it, it should be called a MANUAL. If the content is fun to read yet
informative, it should be called a user guide or a 'GUIDE TO HELP YOU GET
THAT THING WORKING' guide.
Of course, these are MY opinions and the opinions of my company, Highfield
Marketing Group, Inc. I own the company. I can say what I want. :-)
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
