﻿ References - Veeam Technical Writing Guidelines

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.

References Important

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.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.
https://helpcenter.veeam.com/docs/styleguide/tw/references.html
helpcenter.veeam.com
crawl=CC-MAIN-2020-50
28323
application/http; msgtype=response
sha1:VUTCMHHX54ZC3WA3QL5YSMZ2ROSOLRKN
<urn:uuid:28249a84-80ee-41ac-83fc-b0b8a550a928>
2020-11-25T20:07:31Z
52.6.153.112
text/html
sha1:UCTIGQX4MZXZUS6CB7TSP5HNPXUZXWYJ
<urn:uuid:ebd135c8-1eee-4c78-8421-4148fab38a66>
https://helpcenter.veeam.com/docs/styleguide/tw/references.html
response
<urn:uuid:1ef4318b-226e-4895-b1be-a5965cdce81d>
isPartOf: CC-MAIN-2020-50
publisher: Common Crawl
description: Wide crawl of the web for November/December 2020
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-88.ec2.internal
software: Apache Nutch 1.17 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.2-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/