To provide additional information on concepts, terms and any other issues in a document that require supplementary explanation, we use references. A reference is a link that targets either another section in the same document or an external source of information.
In Veeam technical documentation, we use the following combinations — choose no more than 2 combinations and use them throughout the document:
For more information on
<issue that you want to explain>,
see sections <A> and <B>
Note: This applies to references that link to sections in the same document.
For details on
Note: This applies to a reference that links to a section in the same document.
To learn more about
Note: This applies to a reference that links to an external document.
Important! When referencing an external document, pay close attention to the name of the document as stated on the website. For example, depending on the source, you can reference Microsoft documentation or Microsoft Docs, NetApp documentation or the NetApp ONTAP Documentation Center.
To learn how to
Note: This applies to a reference that links to a specific section in an external document.
For detailed instructions on how to
see this Microsoft KB article / this Veeam KB article / this VMware KB article
Note: This applies to a reference that links to an external source of information.
If a reference that links to a section in the same document is preceded by words such as listed in or as described in, it must include the word section or step (depending on the context). For example: