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

Re: User vs Reference Guide

Subject: Re: User vs Reference Guide
From: "Pro TechWriter" <pro -dot- techwriter -at- gmail -dot- com>
To: ekarenski-techwrl -at- yahoo -dot- com
Date: Wed, 21 Feb 2007 12:13:00 -0500

That's a good question. I won't repeat what Joe said, because I agree with
him. My experience has been:

User Guides are for "general" users of the software; the document includes
procedures by *function* to use the program (i.e., How to access the...,
Printing, Entering ...data, and so on)

Reference Guides (sometimes also called "technical references") are usually
for a "speciality" audience, like programmers, database administrators, and
so on. This guide would contain program, database, or code information (such
as screen layouts, database tables, codebases), usually in alpha-numeric
order, sometimes grouped by program function, database table, and so on.

I hope this helps.

PT

On 2/20/07, Karen <ekarenski-techwrl -at- yahoo -dot- com> wrote:


How would you differentiate a User Guide from a Refence Guide?

For so many software programs, it appears that a User Guide is just a
hodge-podge make-up of everything but the kitchen sink!

Karen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 & 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 & Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as pro -dot- techwriter -at- gmail -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/pro.techwriter%40gmail.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.




--
PT
pro -dot- techwriter -at- gmail -dot- com
I'm a Technical Technical Writer!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 vs Reference Guide: From: Karen

Previous by Author: Re: WebHelp: Path for Calling Help in Software
Next by Author: Re: Documenting interactive configuration - HELP!
Previous by Thread: Re: User vs Reference Guide
Next by Thread: getting the comma into Frame index subentries

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

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

Sponsored Ads