TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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?
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-