﻿ Reviewing Data in Screenshots - Veeam Technical Writing Guidelines

Reviewing Data in Screenshots

After you take a screenshot, carefully review the data it contains:

Check Content

The screenshot must be informative — it must not contain empty fields, examples of reports with no data, dashboards with gaps in performance charts and so on.

Empty Screenshot

Check Dates

Dates shown in the screenshot must coincide with the current release version. The screenshot must not show dates in the past (that is, before the release of the solution version) or dates in the future.

If a solution wizard includes a step that has a default description with the current date, it is recommended that you change the description to drop the date before taking a screenshot of the step. In this case, you will not have to update the screenshot every time a newer version is released, unless the design team reworks the wizard. Consider the following example:

Screenshot with Date

  • Good — no need to update the screenshot.

Screenshot Without Date

Check Names

The screenshot must not contain any of the following text:

Do not use your own e-mail address or e-mail addresses that belong to someone in Veeam. If you want to show a fake e-mail address, use either one of the reserved domain names listed in the Reserved Top Level DNS Names document or a domain name that is not reserved yet. Note that you must add a disclaimer at the beginning of the document in the latter case.

  • Russian user names.

Do not use such names as tech.local\ivanpetrovich. If you want to show a fake user name, use a name created by a random name generator (for example, Namey or UINames).

  • Names of Veeam competitors.
  • IP addresses of machines that belong to production domains.

Replace these addresses with either IP addresses used in the Veeam TW lab (that is, a private network) or reserved IP addresses (that is, private and public networks) listed in the IPv4 Address Blocks Reserved for Documentation document.

  • Weird object names.

Do not use such names as myVMdoNotTouchIt, BigBalls and asdfghjkl4757387*&^&^. VMs, hosts, clusters, datastores and other infrastructure objects must have names like those listed in the following table.

 

Reviewing Data in Screenshots Tips

  • As a general rule, avoid capitalization and underscoring when naming infrastructure objects.
  • It is recommended that you name VMs according to their roles in your infrastructure (both fake and real). For example, if you have 2 backup servers deployed in your backup infrastructure, you can name them backupsrv01 and backupsrv02.

 

Object Type

Name

vCenter Server

vcenter01, vcenter02, prod-vc01, prod-vc02

SCVMM Server

vmm01, vmm02

Datacenter

atlanta, columbus, wellington, datacenter01, datacenter02, datacenter03

Datastore

esx01-store01, esx01-store02, vol1, vol2, vol3, backup-store01, backup-store02

Volume

volume01, volume02, volume03

Share

share01, share02, share03

Cluster

cluster01, cluster02, cluster03, analytics, research, ha-cluster, gold, silver, bronze

ESX(i) host

esx01, esx02, esx03, prod-esx01, prod-esx02, prod-esx03

Hyper-V host

hv01.veeam.local, hv02.veeam.local, hv03.veeam.local prod-hv01, prod-hv02, prod-hv03

Virtual machine

apache, appliance, backup, backupsrv, crm, dns, dc, exchange, sharepoint, fileserver, srv, marketing, mediasrv, mssql, mysql, oracle, proxy, sales, sharepoint, sql, systemsecure, webserver, webservices, wiki, win

Network

VM Network, vLab Network, Internal Network, ABC Network

Job

Oracle backup to cloud, Webserver daily replica, CRM backup to tape

 

Reviewing Data in Screenshots Important

The best way to take screenshots is to create and maintain your own lab where each item you want to show has a decent name. However, there may be situations where you still have to edit text in screenshots. For example, this can happen when you connect a lab provided by the QA team to a solution infrastructure. In this case, you must carefully review names of vCenter Servers, SCVMM Servers, datastores, VMs, hosts, user accounts and other objects to avoid personalization and confusion.

 

Disclaimer

If you use names that do not belong to Veeam, add the following disclaimer at the beginning of the document:

This document may include images, program listings and examples that display names of companies, contact persons, address details and the like. Information of this type is fictional and provided for demonstration purposes only. Any resemblance to real companies or people is coincidental.

Show Real-World Examples

The screenshot must show real-world data or at least data that is close to realistic use cases. Consider the following example:

Incorrect Example

  • Good — better to create a sample document and show it in the screenshot.

Correct Example

Be Consistent

All screenshots you take must be consistent both with each other and with the text they follow:

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/reviewing_data_in_screenshots.html
helpcenter.veeam.com
crawl=CC-MAIN-2021-04
36360
application/http; msgtype=response
sha1:77UP4VYMKKXHOURIXEKR7LJW7EMGALXA
<urn:uuid:f05719d3-f983-4916-a4a6-f1ce163ca461>
2021-01-26T05:39:20Z
52.6.153.112
text/html
sha1:WTHK4EEIRZ6PEQLGYZLQ45PQP2YHEFJX
<urn:uuid:7d310ce8-7e83-47fc-a10f-397cab0f91d8>
https://helpcenter.veeam.com/docs/styleguide/tw/reviewing_data_in_screenshots.html
response
<urn:uuid:acc7b0a3-97d8-4977-90df-70e91f8c4ff0>
isPartOf: CC-MAIN-2021-04
publisher: Common Crawl
description: Wide crawl of the web for January 2021
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-12.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/