Internal cross-references
Ensure that cross-references within documents are active hyperlinks, not static text. Use a phrase such as For more information about <xyz>, see
to introduce a cross-reference. Never write the names of sections manually because this often results in a poor user experience and it unnecessarily increases maintenance work for you and other writers. Links and relationship tables enable the user to easily navigate to the section.
Preferred |
Discouraged |
For more information about when to use cross-references, see Cross-reference usage. |
For more information on when to use cross-references, see the Cross-reference usage topic. |
To prevent errors in our authoring environment, avoid adding links within a topic. For example, do not add a link to a table or to steps within the current topic. You can use the following to introduce upcoming content within the topic, such as a table, image, or list. The content you are introducing should come immediately after your current text to prevent confusion.
Example |
The following table provides capacity information: |
