Cross-references
April 15, 2026 ยท View on GitHub
Guidance
Refer to specific section names, table numbers, or figure titles instead of relative position words like "above" or "below." Relative position changes when content is reformatted or reordered.
Examples
Do:
For installation steps, see Install NGINX Plus.
For the full list of supported platforms, see System requirements.
Don't:
See the table above for the full list.
Refer to the steps below to complete the installation.
As mentioned earlier, the system restarts automatically.
Notes
Avoid "above" and "below" entirely. Use the section name or a descriptive phrase instead:
- Don't: See the note above.
- Do: See the note in Configure the virtual server.
Use "preceding" or "following" only when the reference is immediately adjacent and unambiguous.
In the same document, bold the exact section or procedure name when linking without an anchor:
To do so, use the example from the Setting up a virtual server procedure.
Do not include individual cross-references within topics in TechComm content. Collect related links in a separate resources section at the end of the topic.
When linking to external F5 documentation, use the full URL rather than masking the destination.