📝 Headers:
💡 The headers are what dictates the table of contents, so please follow the logical order of header levels. Titles should be inclusive of “How To”.
Main Header
H1 Bold: This is used for first tier topics and we always BOLD it.
Secondary Topic - Second Tier
H2: This is used for second tier topics.
Third Topic
H3: This is used for subsets within second tier topics.
Fourth Topic
This is used for subsets within third tier topics. This is very similar to bolding a normal font.
🧾 Table of Content Verbiage:
💡 The headers are what dictates the table of contents, so please follow the logical order of header verbiage. All of the titles listed below may not be needed for every page.
📝 Overview
Describe what the feature/article will be discussing.
🔑 Authorizations
Any specific Employee/User authorization or role necessary to setup or access feature.
🛠️ Setup
What does our customer need to do to be able to use this feature? Often times, collapsible sections will be used as this can be a long list.
📊 Reporting
Does the feature have a report ties to it as well?
🧑💻 Customer View
Some features are initially set up on the admin side but in the end, it is helpful to note how the customer uses the feature.
❓ FAQs
Any last notes or random things about feature that should be pointed out can be added in a FAQ section.
🔘 Buttons
💡 These are used to navigate customers to a different page, URL, etc. Buttons should be centered.
Used to link to other Help Center Articles:
Used to link multiple other Help Center Articles in same callout:
Use for available software or document downloads:
Use to link to external (non DaySmart) URLS:
If an articles is a part of a series that could not be combined into one article.
🗯️ Callouts
💡 Callouts are used to bring attention to a specific topic and/or break up a large section to ensure we keep the customer's attention.
---------
💡 Used for additional info
🔔 Used for new features / enhancement announcements and "process completion - please proceed"
🧠 Used for examples
⛔️ Stop-gap - Will not be able to proceed if x, y, z
⚠️ Warning - Need to double check something
💡 Please Note:
There are also times we use callouts as another table of contents if there are headers within collapsable sections that should be easily accessible:
** Yes, the above should've been in a blue callout, but I didn't want it to get lost in the sauce in this section - don't @ me! **
👍 Accepted Emojis
💡 This is a list of the common emojis that we use for headers and/or callouts within an article.
Calendar = 📆 | Desktop = 🖥️ | Mobile = 📱 |
Tips = 💡 | Caution = ⚠️ | Search = 🔍 |
Feature Update = 🔔 | Stop Gap = ⛔️ | Example = 🧠 |
Troubleshooting = 🛠️ | Settings (H1) = ⚙️ | Settings (H2) = 🔧 |
📋 Lists
💡 This section describes the different types of list objects and how they should be used.
Bulleted List
This should be used for a generic list of collection of items.
For example, if we're talking about the proper callout colors to use:
Green - Used for new features / enhancement announcements and "process completion - please proceed"
Yellow - Warning - Need to double check something
Gray - Used for examples
Blue - Used for additional info
Red - Stop-gap - Will not be able to proceed if x, y, z
Number List
This should be used for step by step instructions.
Click the link to navigate to the page.
Scroll down to the bottom of the page.
Click save.
Once it's saved, click publish.
🚀 List Spacing Examples
💡 This section describes how to properly space the different types of list examples.
Single Space - Used for quick lists that are not inclusive of specific steps to complete a process
Space Between - Used for steps in a process or lists with longer verbiage
⎅ Dividers
💡 Dividers are used to break up the pages so that they look less overwhelming and more organized - shows clear division of different sections.
System Dividers
System dividers are the ones included within the Intercom style options that are just a straight gray line across (please see above how this page is sectioned).
These should be used before any new H1 Header throughout the article.
These should be an enter before and after the header to give it a little more space.
Custom Dividers
Custom dividers are used to break up large articles that have a few different processes incorporated, these typically have different topics included.
These should also be used before any new H1 Header to start a new section topic.
These should also have an enter before and after the header to give it a little more space.
Examples:
🔤 Word Formatting
💡 This section covers the different type of formatting options for words.
Bold
H1 Titles
Callout Titles
Emphasize words or phrase
Italicize
N/A
URL
When embedding a link in text / sentence, embed the link in the word “here”
Bold “here” and when the word is linked to a URL, it will be underlined
This makes it obvious for the customer
Symbols / Verbiage Clarification
Use “&” vs. “and” in titles / headers
Use "FAQ" vs "Frequently Asked Questions"
📸 Images
💡 Images should be centered - Size will depend on how clear / how small aspects of the image are
🎥 Videos
💡 This section will cover when to use an embedded video vs. a video link within the articles.
Embedded Video: After a section overview / after a section header if no overview
Video Link: If a video is from an external source (a non DaySmart Video)