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.
Subject:RE: Dealing with controls common to multiple tabs From:Paul Hanson <twer_lists_all -at- hotmail -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 24 Jun 2013 12:00:01 -0500
You can use probably create a snippet of the text that describes that
control and then include a reference to that snippet on each page, depending
upon your tool and what output you are creating.
For example, my co-worker built a help system in Confluence - though I'm
pretty sure other HATs have this ability - where "How to Log In" is a
snippet of text. On each page where it was relevant, there is a reference to
that snippet. There are two excellent benefits to this strategy:
1) because the relevant information is on every page, the user does not have
to go somewhere else to read the relevant information.
2) if there is a change to the referenced snippet - like a field is renamed
from "User Name" to "User ID" - that change is made once in the snippet and
all relevant places are updated.
-----Original Message-----
From: Cardimon, Craig
<snip> Every time the control shows up on a tab, I would refer users to the
Common Controls topic, with a link.</snip>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
