Veeam Technical Writing
Style Guide
Search

Introduction (About Solution/Feature)

An introduction topic provides a brief description of a solution or feature, and lists its main components and capabilities.

When to Use Introduction Topic

Use this topic type in case you want to introduce a preliminary topic that concisely describes a solution or feature. All further profound details are usually provided in child topics following the introduction topic.

How to Use Introduction Topic

This topic structure consists of the following elements:

  1. Title — the name of a solution or feature.

Use a title that either consists of or contains the name of the solution or feature. Make sure the keyword is the first word in the title or is placed as close as possible to the beginning of the title.

Do not use ambiguous titles, such as Introduction, Overview or Welcome — each document can have only one topic with such a name, and this must be the first topic in the document.

  1. Definition — a definition of the solution or feature.

Explain what this solution or feature is about: why users could need it, what it does, and what its benefits are (if any).

Do not add pseudo-marketing stuff to the definition, such as <Solution> allows you to reduce costs, mitigate risks and streamline operations — this stuff is not specific and could be used to describe any solution or feature.

  1. Details — further information.

Provide essential information that users must know: on top of what platform the solution or feature runs, with what other solutions it integrates, what usage scenarios it supports, and what actions must be performed to work with the solution or feature (if any).

Do not dive too deep into details. For example, do not list all supported platform versions or OSes — this is what the System Requirements section is for.

  1. List of capabilities — a list of features that are meant to persuade users that they need the solution.

Add 5–6 main features ranked according to their importance to users.

To describe each feature, use the following template: <Feature> — <feature description>, where the first part provides a brief summary for the feature, and the second part includes details on actual solution capabilities.

  1. [Optional] Diagram — a high-level marketing diagram.
  2. [Optional] Links — links to related concept and task topics.

 

Introduction Topic

Introduction (About Solution/Feature)Example 1 (Feature)

Introduction (About Solution/Feature)Example 2 (Solution)

View all results across Veeam
Back to document search