[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: User Guide or User Manual

Subject: Re: User Guide or User Manual
From: Peter Neilson <neilson -at- windstream -dot- net>
To: Said B <said_bazry -at- sigma -dot- co -dot- id>
Date: Sun, 18 Feb 2007 22:46:18 -0500

I have always thought of a User Guide as more informal and perhaps suited to the beginner, while a User Manual would be complete, containing more information than any beginner could properly use.

Imagine that the Widgitoid Company has both kind of books. The lightweight User Guide could be entitled "Using the Widgitoid System" or "Getting Started with Widgitoid." The heavy User Manual might be called "Widgitoid Reference Manual" or "Don't Drop This Widgitoid Manual On Your Foot."

The User Guide might be organized by possible tasks to be solved and would contain copious examples. The User Manual would be alphabetical, contain few, if any, examples, and might give no clues on mapping the information onto a problem set. It might even contain substantial useless or deprecated material.

Others may have ideas that are different from (or totally opposed to) mine.

Said B wrote:

Dear Listers,
I have been searching for sources on the Web explaining the difference
between "User Guide" and "User Manual" but still could not find any. I would
appreciate if any of could give me information on this.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.

References:
User Guide or User Manual: From: Said B

Previous by Author: Re: Agile, SCRUM and Technical Writing
Next by Author: Re: Video vs The Written Word
Previous by Thread: Re: User Guide or User Manual
Next by Thread: RE: User Guide or User Manual

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads