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: Manual or Guide? What is the difference? From:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com> To:"Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>, "SB" <sylvia -dot- braunstein -at- gmail -dot- com> Date:Mon, 18 Aug 2008 10:23:37 -0700
To me, a manual is kind of like filling your mouth with stale,
unsweetened peanut butter while winded. A user's guide, on the other
hand, soothes the user like a cup of hot chocolate on a rainy fall
evening.
Seriously, I think "Manual" connotes reference while "User's Guide"
connotes how to. In other words, a "manual" is artifact centric; a
"user's guide" is user and process centric. In other words, a "manual"
is all about the thing; a "user's guide" is all about how to accomplish
something with the thing.
Leonard
-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Cardimon, Craig
Sent: Monday, August 18, 2008 10:04 AM
To: SB
Cc: Techwr-l
Subject: RE: Manual or Guide? What is the difference?
Sylvia wrote:
What is the difference between Manual and Guide and when is it
preferable to use one over the other?
To me, a manual is large and cumbersome. A manual is kind of like manual
labor. A user guide, on the other hand, gently guides the user along. I
always use the term User Guide. I never use the term Manual or Reference
Manual.
Craig Cardimon
Technical Writer
Marketing Systems Group
ccardimon -at- m-s-g -dot- com
************************************************************************
*****************************************************************
Information contained in this e-mail transmission is privileged and
confidential. If you are not the intended recipient of this email,
do not read, distribute or reproduce this transmission (including any
attachments). If you have received this e-mail in error, please
immediately notify the sender by telephone or email reply.
************************************************************************
*****************************************************************
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as
Leonard -dot- Porrello -at- soleratec -dot- com -dot-
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
