Use cross-references to identify information that is related to a specific topic.

2.6.1. Guidelines for Writing Cross-References

Use the following guidelines for creating and using cross-references:

  • Use cross-references where related information is already described elsewhere in the document and is not essential to the current discussion.

  • Do not include a cross-reference to information that is essential for the reader to understand the current discussion. In this situation, you should restructure the document to include the information in the current discussion, or at least summarize the essential information in the current discussion.

  • Use specific and clear phrases to introduce cross-references.

    Ambiguous: To configure, see Settings.
    Clear: For information about how to configure the applet, see Settings.
  • Use hyperlinks for cross-references in online documentation.