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:"McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com> To:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>, "Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>, "SB" <sylvia -dot- braunstein -at- gmail -dot- com> Date:Mon, 18 Aug 2008 13:53:04 -0400
I agree with Leonard and Craig, and would normally use "User Guide" by
default, but keep in mind that there are occasions when the intended
audience expects "Manual" or even "Reference Manual" - an audience such
as the engineers and techs and programmers who use our toolkits.
- Kevin
> -----Original Message-----
> From:
techwr-l-bounces+kevin -dot- mclauchlan=safenet-inc -dot- com -at- lists -dot- techwr-l -dot- com
>
[mailto:techwr-l-bounces+kevin -dot- mclauchlan=safenet-inc -dot- com -at- lists -dot- techwr-
> l.com] On Behalf Of Leonard C. Porrello
> Sent: Monday, August 18, 2008 13:24
> To: Cardimon, Craig; SB
> Cc: Techwr-l
> Subject: RE: Manual or Guide? What is the difference?
>
> 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
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
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-