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.
RE: Hypertext links -- how best to make these useful
Subject:RE: Hypertext links -- how best to make these useful From:Fiona Hanington <fiona -dot- hanington -at- ericsson -dot- com> To:Julie Stickler <jstickler -at- gmail -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- techwr-l -dot- com> Date:Fri, 26 Oct 2012 12:10:21 -0400
Good suggestion - I've seen something similar from Viso's Help:
- How Do I...
- Show Me...
- Tell Me About...
The above are a bit too conversational for our style, but I've gotten some excellent ideas here.
Thanks all,
Fiona
-----Original Message-----
From: Julie Stickler [mailto:jstickler -at- gmail -dot- com]
Sent: October-26-12 6:42 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Cc: Fiona Hanington
Subject: Re: Hypertext links -- how best to make these useful
On Thu, Oct 25, 2012 at 7:02 PM, Fiona Hanington <fiona -dot- hanington -at- ericsson -dot- com> wrote:
> Imagine you have this sentence:
>
> "After you <link>defragment the disk</link>, ...."
Don't feel like you need to stay with your current structure.
Sometimes revising how you've written something makes it easier. For example, if you used a structure like the following, with appropriately descriptive headings, it should be clear where your links lead.
Prerequisites
- [Link - Installing the widget]
- [Link - Configuring the widget]
To calibrate the widget, complete the following steps:
Step 1
Step 2
etc.
After you have calibrated the widget you must next [Link - Initialize the widget] before you can [Link - Use the widget].
--
Julie Stickler http://heratech.wordpress.com/
Blogging about Agile and technical writing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: You have more time to author content with Doc-To-Help, because your project can be up and running in 3 steps.
See the “Getting Started with Doc-To-Help” blog post. http://bit.ly/doc-to-help-3-steps
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
