Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.
Last updated on

Overview

↑ Docs content model

An overview is the opening section of a page. It tells a reader, in the first screen, what the page covers, who it is for, and what they will be able to do — before any prerequisites or steps.

When to use​

Every page type has an overview. It is the unlabeled content directly under the H1, before the first H2. Use it to orient the reader and let them confirm they are in the right place.

Composed of​

  • Headings — the page H1 sits directly above the overview.
  • Links — link the concepts and products the overview names.
  • Admonitions — an :::info[Preview] callout here flags a page documenting a Preview feature.

Technical details​

  • The overview is the paragraph (or two) between the H1 and the first H2. It has no heading of its own.
  • Keep it short — two to four sentences. Detail belongs in the sections that follow.
  • If the feature is in Preview, place the admonition immediately after the overview paragraph.

Rules​

  • Lead the first sentence with what the reader can do or learn, not with background.
  • Do not start with "This page describes…" or "In this article…". State the subject directly.
  • Name the audience if it is not obvious (for example, "for workspace admins").

Style​

  • Present tense, active voice.
  • Introduce any product name in full on first use, then use the short form.

Template​

Markdown
# <Page title>

<One or two sentences: what this is and what the reader can do with it.>
<Optional: who it's for.>

Examples​

Lakeflow Jobs lets you orchestrate data processing, machine learning, and analytics pipelines on Databricks. This tutorial shows you how to create and run your first job.

Used in​

On this page