Creating User-friendly Links

Google returns millions of search results to the technical question of how to code hyperlinks in HTML. However, a question on how link texts should be formulated, so that the reader can understand them clearly, fetches only a handful of usable tips. Even most style guides and authoring guidelines are quite reticent on this topic. In this article you will find tips on this rarely dealt with, though important subject for technical communicators.

"Click me!" – "If you don’t click me, you will miss out on something!" Every reader is constantly faced with the decision: Should I yield to the alluring call of a link? Should I really leave the current topic, or should I rather read on? If the reader decides to click a link, but the topic that opens up does not contain the information that was expected, frustration grows.

The most important basic rule for link texts is to give the reader something to help decide: Where will a likt take me? What kind of information can I expect there, and for what applications? Will there be plenty of information, or bare minimum? Will it be easy, or difficult to digest? Will there be practical examples or abstract theory? What are the benefits from following the link? What is the effort associated with the click? The greater the share of this information that can be communicated even BEFORE opening the new topic, the better.

Since many readers just scan online help text briefly, it is generally not enough if the information about the link is given in the accompanying text: it should be present in the link text itself.

 

Example:

Not: "Click here for more information."

Not: "Click here for more information."

Not: "Click here for the results of our usability study."

Instead: "Most users prefer links at the end of a topic; this is confirmed by the results of our usability study on navigation (3 pages)."

 

Short formulations such as the favorite "(more…)" are meaningful only if they are located near a clear title. This is the case, for example, in tables or in tabular listings of keywords plus explanation, followed by "(more…)".
Use simple, univocal terminology. Avoid all attempts at playing with words, and implications. It should be possible to just read the link text even without knowing the overall context. If the explanation of a term in the link is given only in the text that it leads to, it is already too late, the user is already on a dead-end street.
Indicate the size and file format for all downloadable objects.

 

Not: "See also: Checklist."

Rather: "Checklist for linking (PDF 1.2 MB, requires Acrobat Reader 8.0 or above)".

 

Similarly, mention any access pre-requisites or restrictions at the end of the link, and not as part of the topic being accessed.

Examples: "(Only for registered users)", "(Only Professional Version")

 

If the reader clicks a link, something new and unknown awaits him. The unknown always gives rise to anxieties, and these come in the way of acceptance. Give the reader a sense of security by making sure that at least one keyword from the link text corresponds to the title of the subject invoked. This will banish all doubts about whether the reader has landed in the wrong place. Repeating the familiar term creates confidence and contributes to the first feelings of success.

Well formulated links let the user know without ambiguity what kind of information to expect in the topics referenced. It can become very difficult to limit these link texts to a reasonable length. Here, link titles, using the HTML title tag can serve as a good supplement. HTML link titles are displayed when the user hovers with the mouse over the link.

Example:

Every user ought to know how to code<a href="examples.html" title="Source text examples for link titles">link titles</a> in HTML.

This HTML code generates the text: "Every user ought to know how to code link titles in HTML." If the reader allows the mouse to hover a few seconds over the link, the following additional text appears in a popup: "Source text examples for link titles".

The link title reduces the user’s risk of entering a dead-end street. At the same time, it becomes easier to situate the referenced page in its context. The reader will be in a position to start absorbing the information immediately, without first having to find out what the whole thing is all about.

It is particularly helpful if the title of the link can reveal the type of information involved (step-by-step instructions, background information, references or examples), and how this information is related to the current topic. Often, a single keyword, such as "(Example)", serves well enough as a hint.
If the link is the name of a person or a company, the title of the link should indicate whether the link leads to a web site or is a "mailto" link which will launch an e-mail client for contacting the person concerned.
The time spent in waiting for the link title to appear, and in reading the link title itself mean an additional investment for the reader. That is why link titles should be seen only as a special supplement for users having a reason to be interested in the link. Do not use the title of the link as a patch for loosely formulated link texts. Use a link title only if it really adds value to the link text. If the link text itself is clear and unequivocal, even better. Adding link titles merely in order to maintain consistency is not an adequate justification.
Keep link titles as simple, brief and straightforward as possible. A maximum of 40 to 60 characters should do.

The problem of conveying information about the destination becomes particularly serious in the case of links on graphics. Only rarely images or symbols alone are enough as explanation.

This difficulty is particularly frequent in web sites that are predominantly marketing oriented. As an extreme example, take the case of a bank’s web site: like in all banking advertisements, pictures of happy, dynamic people of the younger generation greet you. Clicking on the images will take you to the various information zones. How many smiling faces do you have to click on before you can finally access the price tables of your current account? A phrase has already been coined for this phenomenon: "Mystery Meat Navigation". Just like you can never know at the meat counter what exactly the butcher has put into your sausage.

If you are linking graphics, add some text as well, so that the target can be anticipated at first glance.
As with text links, even in the case of graphics, the link titles with the TITLE Tag should just be used as a supplement, because they imply more waiting time and do not really receive attention from all readers.

Every link draws the attention of the reader away from the actual content. This happens because the layout stands out prominently (underlining), and because of the anxiety over losing out on important information by not reading the text "concealed" by the link. Further impediments arise because sentences grow longer or more complicated on account of the links.

The ideal link is integrated into the text in such a way that the sentence would read just the same even if the link had not been there. In the ideal case, the link text should not contain any navigational information; instead, it should contain information that is purely related to the content.

Not: "You can find out which family of birds Starlings belong to under the link Migratory and Stationary Birds."

Rather: "Starlings are Migratory birds."

There is only one exception: If it is a link to a web site and it is likely that the user will print a topic, then include the complete URL in the link text. The same applies to printed documentation, such as manuals, of course.

Do not try to advertise your links. There is no need to refer explicitly to a link in the text – it stands out on its own.

Not: "Click here to start the tutorial."

Rather: "You can find a step-by-step introduction in the Tutorial."

Do not interrupt your sentences by inserting links. See how this fake link draws attention to itself? Whenever you integrate a link into running text, put it right at the end of the sentence. Likewise, try to place the sentence with link at the end of a paragraph, and try to place the paragraph containing the link at the end of the topic.
Avoid links that run into several lines. These cannot be registered by the reader at first sight and many readers even see them as separate links.

Remember that the probability that a sentence might have to be split into two or more parts during translation increases with the length of the original sentence. The translator will then have to decide which fragment should host the link. This partial loss of "context" will definitely reduce the communicative power of the link.

If links need to be split or moved, it means essentially more editing effort, and, in technical terms, it is highly error prone. If the translator does not have the required software, this task is usually left to the author or to the translation coordinator.

If the translator is working with a translation memory system, links in the middle of a sentence can make it more difficult to recognize already translated segments. This is because the translation memory divides a sentence with a link differently from one without any links, namely, into three segments: the part of the sentence preceding the link, the link text and the part of the sentence that follows it.

Translator friendly links are short and ideally situated apart from the running text, such as in a separate table.

Challenges of a special nature crop up when text modules are going to be put to multiple use. The following scenarios could arise:

 

Scenario 1:

The same module is used to generate both print media (printed manuals, PDF) as well as online media (online help, web site, multimedia). The page number will have to be mentioned extra for the cross references in the print media. To help in identifying the target without ambiguity, the title will have to be mentioned as well. In the online version, on the other hand, typical texts that appear in printed manuals, such as "see page x" or chapter or section numbers should not appear on any account. Also, there is no need to cite the complete title here.

Powerful single source tools and content management systems are capable of creating the print versions automatically. In your source text, make sure to avoid all media-specific words like "topic", "chapter" or "page". Such terms are allowed only in their appropriate versions and should be inserted by the authoring system at the time of generating the document. The same applies to page numbers. The way you formulate your text should take all this into account.

 

Example for scenario 1:

Online: Additional information about the graphics format can be found under The right format for your case.

Print: Additional information about the graphics format can be found under "The right format for your case" (chapter 5.8) on page 225.

 

or (better still):

Online: Before you can use this function you will need an additional license key.

Print: Before you can use this function you will need an additional license key (see chapter 1.3, "Acquiring additional license keys" on page 13).

 

Scenario 2:

The same text modules are used for documents referring to different product versions. It might happen that in some of these versions, certain targets do not exist at all. In such cases, there should be no references to indicate the presence of a link at this point in some other version.

 

Scenario 3:

Not every link that appears in the online version for reasons of comfort is worthwhile to interrupt the flow of the text with a reference to the chapter heading and page number in the printed version. Thus, usually the printed version should suppress certain links, which are present only in the online versions. Also in this case, there must be no explicit reference to the link.

Example for scenarios 2 and 3:

Online: You can protect your data against unauthorized access by using the integrated encryption function.

Print: You can protect your data against unauthorized access by using the integrated encryption function.

In actual practice, it is not always possible to satisfy all the requirements of good links, like uniqueness, brevity, and integration into the flow of the sentence. And if the texts are going to be put to multiple use (single source publishing), how to formulate them becomes a real challenge. There are several good reasons clearly separate the text from navigation, and to remove the majority of the links from the actual body of the text:

readers’ attention is not diverted from the text they are reading, there is no temptation to click in a hurry
links can be followed without having to read the contents within the topic
formulation is significantly simpler, especially in the case of single source projects
administration is significantly simpler (tool-dependent)
translation is significantly simpler

 

One tried and tested approach is to include only those links into the main body of the text, which really justify any interruption in the flow of the text. A rule of thumb that is useful here: In a private conversation, would you interrupt the other person at this point to draw his or her attention to some additional information? If the answer is yes, the link is probably justified in the text. You can move all other links to a place beside the text or onto another navigational device. Here, again, the same rules of style and formulation apply, but things get considerably simpler.

The most important basic rules

Formulate links in such a way that the content and information type of the target address are clearly recognizable.
Add explanatory text even to linked graphics and symbols.
The link text should be unique and clear in its meaning, even without the overall context of the surrounding text.
Keep the style simple and concise. The briefer the link text, the better.
Repeat at least one key word from the title of the target topic in the link text.
Use the link title (HTML-Tag TITLE) to further specify the content and type of information in the target.
Integrate links into the sentence in such a way that the sentence would read just the same even if it contained no links. Include content related information in the link text and not just information for navigation.
Place links preferably at the end of sentences, paragraphs and topics.
In the source text of a single source document, avoid using media specific terms like "topic" or "chapter".
Embed only the most important of the links in the running text. Move the majority of your links out of the text and into a separate navigation zone. The formulation becomes considerably simpler then, and, if the topic titles are formulated carefully, this can even be automated to a certain extent.
 

Copyright | Terms of Use | Linking to indoition | Imprint

Newsfeed

 
Welcome to indoition engineering Marc Achtelig,

User Assistance Solutions & Technical Documentation Services.
Here you can find
Know-how,
Tools,
Templates,
Professional Services

for the creation of
Manuals,
Online Help,
Software Demos.
A service of indoition engineering Marc Achtelig – documentation contractor, online help specialist, single source publishing expert.
Show intro: