References

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:

Dependent Clause

 

Independent Clause

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

see <section>

Note: This applies to a reference that links to a section in the same document.

To learn more about

  • see the <User Guide>
  • see Microsoft Docs / VMware Docs

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.

 

Important

  • 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, For Veeam Backup for Google Cloud to be able to authorize in Google Cloud, the OAuth consent screen must be configured as described in section Registering Applications, and For a CMEK to be displayed in the list of available encryption keys, it must be stored in the region selected at step 6 of the wizard.

  • If you want to include into a section a reference (or a number of references) that provides additional information not only on a concept, term or any other issue mentioned in this section — but on the section as a whole, you can use one of the following headings to introduce the reference: In This Section, Related Topics, Related Tasks, Related Resources, Related Commands or See Also. To introduce a number of references, use a bulleted list.