Re: guide vs manual

Subject: Re: guide vs manual
From: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
To: saradha -dot- krishnamurty -at- gmail -dot- com, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 06 Feb 2007 13:26:50 +0900

Hi Saradha -
**
> Is there a difference between a User Guide and a User Manual.

I don't think there's a definitive answer as to what can and can't be in a user guide and what can and can't be in a user manual. Generally I might expect a Guide to explain concepts and describe procedures, and a Manual to contain reference information, but I probably wouldn't notice if I came across a Reference Guide or a Concepts and Procedures Manual. I think it also depends on the industry--users of a government web site, a defence application and a mobile phone probably have different expectations of what is meant by the words 'guide' and 'manual'.

You can avoid the problem by calling the book "Using <product>" rather than "<product> User Guide" or "<product> User Manual".

So if you're writing the documentation for a product called XYZ, any of these would work:
XYZ Guide and Reference
XYZ User Manual
XYZ User Guide
Using XYZ
Installing XYZ
XYZ Installation Guide

'Manual' seems to work better as a collective noun. "Have you seen the XYZ manuals?" sounds more natural to me than "Have you seen the XYZ guides?".

Regards

Stuart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: RE: Interviewing Tech Writers
Next by Author: Neilsen's Ten Usability Heuristics
Previous by Thread: Re: guide vs manual
Next by Thread: maintaining a list of changes in User Guides between versions


What this post helpful? Share it with friends and colleagues:


Sponsored Ads