RE: Dealing with controls common to multiple tabs

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.

Hope that helps.

Paul Hanson
Senior Technical Writer
blog: http://prhmusic.blogspot.com
Twitter: @phrmusic - follow me!

-----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.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Previous by Author: RE: Numbered versus unnumbered heads in very technical reference guides
Next by Author: Re: Numbered versus unnumbered heads in very technical reference guides
Previous by Thread: Re: Technical communicator vs. technical writer
Next by Thread: A softer word for "honesty" or "integrity" ?


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

Sponsored Ads


Sponsored Ads