Cross-references
Key Point
💡 Use cross-references to guide readers to related information.
Cross-references link to nonessential information that adds to the reader's understanding.
References to other documents
- Give an explanation as to why you are referring the reader to this information.
👍 Recommended: For more information, see the installation guide.
- Use meaningful link text.
Cross-references within generated reference documents
For linking from one reference topic to another in generated reference documents, use the reference generator's standard linking syntax.
Formatting cross-references
When a cross-reference is a link, don't put the link text in quotation marks.
👍 Recommended: For more information, see the installation guide.
👍 Recommended: For more information, see Make link text meaningful.