FW: Reference Guide vs. User's guide

Subject: FW: Reference Guide vs. User's guide
From: "Dave Neufeld" <Dave_Neufeld -at- spectrumsignal -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 27 May 2002 17:26:34 -0700


-Mubeena asked:
-What is the difference between a reference manual and a user's guide? I am a


How 'bout an extreme, quick and dirty analogy?

A reference guide is to a user guide like a dictionary is to a an essay.

People look things up in a non-linear fashion in a dictionary. They don't start at aardvark, read for a few hours, put in a bookmark, pick it up again and continuing until they finish the zzzzz's. Reference guides are bone-chilling objective in nature.

An essay, however, is read from the start to the finish in a linear fashion. You have to read the previous paragraph to fully understand the current paragraph. You can't jump in just anywhere. And it is not designed to look stuff up in. Essays can be wanderingly subjective.

Now the analogy is not as extreme in the case of reference and user guides. Readers can approach reference guides in a linear fashion. Especially geeks. But they are primarily designed to be used in a look-up-a-factoid-quick approach. And information in user guides is often systematically and hierarchally chunked into bite-sized morsels that can be jumped to from the table of contents, or even by skimming section headings.


Another difference is that reference guides explain more of what something is and how IT works. A user guide describes how the reader (or user) uh, uses it. Usually starting with the first tasks a user would do, such as installing it.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l

Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: RE: .NET and javadoc (SIDELINE FROM: Directions for tomorrow's techwriting)
Next by Author: Re: Recent unusual interview experiences
Previous by Thread: Reference Guide vs. User's guide
Next by Thread: Return or Enter for US users


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


Sponsored Ads