Headings and page names headings
Headings serve as both the structural outline of your page and a point of reference for readers when scanning content. Scanning becomes easier when you use headings to break content into natural, digestible chunks of information.
Headings can be displayed in search results, snippets, popovers, and so on. The following editorial guidance ensures that headings work in every context we use them.
Editorial guidance for headings
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 15-row-2 16-row-2 | |
---|---|
Editorial guideline | Description |
Concept headings (nouns) | For concepts, use brief nouns and noun phrases, such as Analytics administration guide or Organizations in Experience Cloud. |
Task headings (verbs) | Use strong, active verbs, such as Create a customer attribute file or Get started with segmentation. Do not use gerunds (-ing verbs) |
Capitalization | Use sentence case for all headings and navigation elements (heads, subheads, TOC entries). (Exception: Use title case only on Title metadata.) |
Punctuation |
Do not punctuate a heading like a sentence. Punctuation exists only to remove confusion (such as a period to separate sentences). Exceptions: Use a question mark only if the heading asks a question (such as in an FAQ). Certain creative, marketing style headings may need punctuation (to avoid a sentence splice) |
Parallelism |
Maintain a parallel structure whenever creating scannable content. Headings, like lists, should be parallel in most cases. For example, on a page with several headings for concepts and tasks, use noun phrases for all first-level headings, verb phrases for second-level headings, and infinitive phrases for headings preceding a procedure. |
Content after a heading / double headings | Every heading should have regular paragraph text after it. Avoid placing notes, lists, tables, or links directly after a heading, because these elements typically require explanatory text. |
Single-word headings | Do not use single-word abstract entries like Overview or Introduction, especially for page names (H1s). (Describe what the overview or introduction is about.) |
Simplicity - too many nouns |
Avoid multinoun concept headings. Difficult: Adobe Photoshop layers video playlist Simple: Video playlist for Photoshop layers |
Simplicity - too many verbs |
Avoid multiverb tasks headings. Difficult: Create, edit, and upload customer attributes Simple: Manage customer attributes |
Nounifying verbs | Avoid adding -ment or -ion (Create a roadmap vs. Roadmap creation). |
Numbering | Do not number a H1. Avoid numbering subheadings, but some exceptions exist (i.e., in long tutorials). Preferably, use Step 1: Heading name. |
Length | Be brief. Try not to exceed five words. |
Product names | Remove the product name unless doing so causes confusion. (Product names added automatically in title metadata. In Universal Editor, add the product name to title.) |
Keywords in headings |
Keywords improve SEO. They include feature names, interface elements, and the task being performed. Example: Upload customer attributes contains action performed in the interface. |
Singular form |
Consistent use of the singular form is easier to read. Example: Save a workspace (not Save workspaces) |
Jargon and informality |
Localization must be able to translate all headings, so show restraint regarding informal headings or jargon. Product documentation must follow this guidance. Videos (and events) that feature personalities have more room to be slightly creative and informal, but not overly so. |
Heading types
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 | ||
---|---|---|
Type | Examples | Description |
Guide title | Adobe Target user guide, Adobe Experience Manager tutorials | The guide title (the H1 on your home page) is intended to be the formal name of your guide. Use the full title wherever you reference it. (Use sentence case.) |
Introduction to… |
|
Introductions present a new product and generally describe what it does at a high level. Your guide should include only one introduction, placed at the beginning of the guide where new customers see it. (Not to be confused with overview.) Never use the single word Introduction by itself in a heading. |
Overview of… |
|
Overviews describe multiple or single features, how products and features work together, and what you can accomplish using the product. Important: Never name a page Overview without naming what the overview is about. Do not name a landing page Overview. If you must describe the purpose of your guide on its landing page, use an About this guide subheading and describe it there. |
Fundamentals of… | Fundamentals of Campaign v8 | Fundamentals are similar to an overview but more ground-level and hands-on. |
Get started with… | Get started using customer attributes | A get started guide walks through the initial steps to perform when using a feature. Customers expect to be using the interface in a get started article or lesson. |
Tutorial headings |
|
Treat the tutorial headings for your home page the same as the guide title. |
What’s new… | What’s new in Experience Cloud |
Use What’s new headings to introduce new features in a product release. Use the product name with What’s new headings. These headings differ from release notes, which provide features and fixes in a release. Do not add a question mark after this heading. |
Prerequisites | Prerequisites for administrators | Do not hyphenate. Follow this heading with a bullet list of prerequisites. |
What you’ll learn | What you’ll learn | Create a bullet list of useful summary content for a large body of content or video transcript. Consider using Summary AI to help create content from video transcripts. Ensure that your list is parallel. |
Integrations |
Adobe Campaign integration with Adobe Experience Manager Integrate Adobe Campaign and Experience Manager |
Use Adobe in front of the product name on first use. You don’t need to repeat Adobe in secondary uses. |
More help on this topic (the ExL feature) | More help on this topic |
This heading is automatically added at the bottom of a page (assuming that the Recommendations feature is enabled by SCCM). A bullet list of recommended articles is also added. Ensure that your H1 headings adhere to capitalization standards, and that you have feature tagging correctly set up for this feature to work. The Recommendations feature pulls in the H1 from other pages and creates a bullet list. If the H1 being fetched is Overview or Introduction (only one word), the list of recommendations will not make sense. |
Subheadings subheadings
Subheadings let you break up large chunks of information into scannable chunks. They are level two (H2) or three (H3) headings. They are the structural outline of your page and a point of reference for readers when scanning content.
Subheads follow the same editorial guidelines as H1s (see previous section).
Examples of standardized subheads:
- Prerequisites
- Before you begin
- What you will learn
- More help on this topic
Heading structure for concepts and tasks
Common structural designs for headings.
Multipage
TOCs used to strictly separate information based on content types:
-
Concept (parent page)
- Task (child page)
- Task (child page)
- Task (child page)
Single page (combining H1 concept with multiple H2 tasks)
In Experience League, you combine a concept H1 with multiple tasks subheads.
Concept (H1)
Task (Subhead2)
Task (Subhead2)
Task (Subhead2)
Here’s an example of a concept page with task subheadings:
Title: Fallout Report | Adobe Analytics
Description: Learn about Fallout reports in Analytics. Create, run, and share them with Experience Cloud users.
H1 - Fallout report in Analysis Workspace
Para(s): Conceptual information about Fallout reports and what you can do with them (such as create, run, and share). List prerequisites or caveats, and so on.
H2 - Create a Fallout report
Para: Context about this particular task.
Bold para (orients reader to begin): To create a Fallout report
Steps to create the report.
H2 - Run a Fallout report
Para: Context about this task.
Bold para (orients reader to begin): To run a Fallout report
Steps to run the report.
H2 - Share a Fallout report
Context para about sharing the report
Bold para (orients reader to begin): To share a Fallout report
Steps to share the report.
If you don’t have context information, you can immediately begin the steps after the subhead. The “To” heading should match its parent heading.