📝 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
This is used for first tier topics.
Secondary Topic - Second Tier
This is used for second tier topics.
Third Topic
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.
Used to link to other Help Center Articles:
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