See Also/Related Topics

Subject: See Also/Related Topics
From: "Zen C" <zenizenc -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 13 Aug 2007 20:45:11 -0400

Hi All,

I am asked to edit an existing online help file and in that each heading has
a "See Also" and "Related Topics" link. Although for me both words mean the
same, the reasoning I was given got me thinking cos of the way the the help
file is organized.

See Also is linked to topics that has additional information which is
associated with the topic (For example: each field in a window is described
as a separate topic, therefore when describing the main window the "see
also" link is attached to each heading that describe the field) and Related
topics are "how to" topics associated with a window.

Also "see also" is a secondary window and "related topics" point to the how
to topic in TOC. These are not standards that must be followed.

Anyways I hope I make sense and this is my question to all of you:

Is there a set standard or a preferred method with regard to using related
topics and see also?

Zen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

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-

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%40web.techwr-l.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/ for more resources and info.


Follow-Ups:

Previous by Author: Re: Numbering graphics in Word
Next by Author: Release Notes
Previous by Thread: RE: Random Names and JAD
Next by Thread: RE: See Also/Related Topics


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


Sponsored Ads