Veeam Technical Writing
Style Guide

Search

Veeam Technical Writing
Style Guide

Introduction
Structuring Content

Inverted Pyramid Structure

Paragraphs
Notes

Topic Types

Concept Topic

Introduction (About Solution/Feature)
Deployment Scenario
Component
How It Works

Task Topic

How-To Task
Supertask

Reference Topic

PowerShell Cmdlet Reference

Operation

Cmdlet

REST API Reference

Resource Сollection

Common Properties
Endpoints and Methods

Operation

Plain English

Short Sentences
Split Information

Headings
Lists

Simple Verb Tenses
Active Voice
Clear Adverbial Phrases
Correct Modal Verbs
Less Gerunds
Understandable Language
Less Attributive Nouns

Articles

Indefinite Article
Definite Article
Zero Article

Punctuation

Comma

Oxford Comma

Colon and Semicolon
Dash and Hyphen
Parentheses

Images

Configuring Appearance Settings

Disabling Font Smoothing for Remote Desktop Connections
Disabling Font Smoothing in Web Browser

Taking Screenshots
Reviewing Data in Screenshots

Editing Screenshots

Adjusting Image Size
Including Image Tooltips
Aligning Images with Text

Formatting
References
Tips and Tricks

>Style Guide>Structuring Content>Topic Types

Topic Types

In this article

There are 3 types of topics used in Veeam technical documentation:

Concept
Task
Reference

Page updated 3/9/2020

Send feedback

Home | Products | Forums | Support | Contact Sales | EULA

©2021 Veeam® Software Privacy Policy & Cookies

This document
Help Center

I want to report a typo

There is a misspelling right here:

I want to let the Veeam Documentation Team know about that.

Submit report