One might think: “How difficult can it be to use navigation links in technical documentation? I know where they are in my application, so I just use them.” Well, you’ll be surprised at how easy it is to screw things up with navigation links and make your readers frustrated and helpless. This article will explain what a navigation link is, its purpose, correct usage, and much more.
Purpose of navigation links
So, why do we use navigation links in our content and why are they so important?
To keep it simple, navigation links help make your content more concise, accurate, and easier to find for your readers. A navigation link is a reference to additional source of information in a specific place in the other topic, file, or page.
Here are some basic advantages of using navigation links:
- Help users scan content for relevant information.
- Provide details on subjects that interest users.
- Help users navigate the content the way they want.
- Improve the SEO (Search Engine Optimization) for online content.
Incorrect usage of navigation links
Let’s have a look at typical mistakes that we make when creating navigation links:
- Indistinct or ambiguous names of links
E.g. For more information, click here
Readers have absolutely no idea where such link would take them. So, try using keywords in the names of links to make links more action-oriented.
- Address/URL in names of links
E.g. For more information, visit https://en.wikipedia.org/wiki/Hyperlink
Such links take a lot of space and make the content look unprofessional.
- Wrong words for names of links
E.g. For details, download information here
When you link the wrong word (“here” instead of “download”), users may misunderstand the purpose of a link. Also, try providing additional information about a format and size of the file.
- General words in names of links
E.g. For more information about links, their purpose, and usage… More >
While scanning the text, readers won’t get any information from the names of these links.
- Long names of links
E.g. For more information about navigation links, their purpose, types, and usage…
If you use a couple of different links in a row, users will see them as one endless link.
- Incorrect underlining
E.g. For more information about links, their purpose, and usage, see information about links.
Underlined words look like navigation links, and readers will try to click them. Do not underline the content that is not supposed to be a link.
- Very short names of links
E.g. For more information about it, see…
Do not use a very short word as a name of a link because users might not notice it. Not to mention that clicking such link is a real challenge.
Correct usage of navigation links
“Everyone knows how to use navigation links. There is no need for an explanation,” you’ll say. Well, I disagree. We are so used to throwing links all over the topic in great amounts that, inevitably, we force our readers to leave our page as soon as possible. This is when the rule “The more, the better” does not justify itself.
Try to follow these guidelines on how to use navigation links, and you’ll make your content accurate and scannable for your readers.
- Use keywords in the names of links.
- Limit a link text to two-three words, if possible. Shorter links are easier to scan.
- Provide links for more detailed information only when necessary. If you can omit using links without the loss of the important information, then do.
- Write the name of a link that is meaningful and brief.
- Try not to use links circularly (don’t link back to the original content).
- Make link text distinct. Never rely on color by itself to indicate a link. Use both the color and underlining, so that color-blind readers could identify the link text.
The proper usage of navigation links will make your content more concise, accurate, and easier to scan. Give your readers freedom to decide which content to read and which to omit.
In the next article “Navigation Links: Types and Usage”, you will learn about the most common types of navigation links, pros and cons of each type, and much more.