Title Guidelines

• Use title case
• Use nouns or noun phrases

Examples: “Account Summary”, “Projects Interface”

Style Guidelines

• Convey the essential information about a concept
• Provide only conceptual information, not reference or procedural information
• Focus only on one particular idea

Considerations

Ask yourself the following questions when creating concept topics:

• Is there relevant background information a reader needs?
• Are there technical notions for understanding x that need definition?
• What are x's most important features or characteristics?
• Would an example help clarify what x is?

Structure

concept topics can contain the following elements:

• concept element
  1. title element
  2. abstract element
     • short description element
  3. prolog element
  4. concept body element
     • section element
     • paragraph element
     • example element
     • definition list element
     • unordered list element
     • ordered list element

Elements

title element

Entitles a topic, a section, or a container element.

abstract element

Provides introductory content that would be unfit for a short description element.

short description element

Illustrates the topic purpose in two or three sentences (no more than 50 words). short description elements can provide content for link previews and search engines.

prolog element

Contains topic metadata. Can contain multiple resource ID elements that you can use to implement context-sensitive help into applications.

concept body element

The main element of a concept topic.

section element

Contains relevant content.

paragraph element

Encapsulates a single idea in a paragraph.

example element

Illustrates or supports a topic by providing relevant examples.

definition list element

Contains a list of terms and their definitions.

unordered list element

Contains a list of items whose order is not important.

ordered list element

Contains a list of items whose order is important.

Concept Topic Example