First comes an introduction. This provides a quick overview of what the feature does and where applicable how it can benefit companies. This is written in normal text.
H2 Headings For Sections
H2 headings should be used for the various sections in the article, this is just SEO/accessibility best practices. Sections would typically be "Enabling", "Settings", "Usage" etc.
For sub-headings within a section, you can use underline. For example:
This is a sub-heading
This is text under the sub-heading.
Other Text Styling
If you are listing a large number of settings, you can use underline to make the name of each setting stand out more. You should also use a numbered list to indent it. For example:
Setting 1: Setting description here.
Setting 2: Setting description here.
Setting 3: Setting description here.
If you are listing longer items, such as error messages, you can use italics to keep these separate from other text. Depending on how many there are, you can use a numbered list or bullets. For example:
This is an error message - here is a description of the error message.
This is another error message - here is a description of the error message.
In some cases, you may need to add a prominent note. In that case, you can switch to the code view </> and insert the note using <div class="note">:
NOTE: This is a note. It provides readers with important information related to a feature.
NOTE: This is a blue note. It uses class="note-tip". It is typically used for tips and notes about early access features.
When inserting code snippets, use the code block feature to make this stand out more. For example:
<iframe src="url" title="description"></iframe>
Images
If you include screenshots in the article, make sure that they meet the following guidelines:
Screenshot info is relevant.
Image is clear and not pixellated/blurry.
Sample data, such as customer names, look real (for example, don't call a customer "Darth Vader").
There is some sort of border or edge included in the screenshot to make it stand out from the white background of the article.
Resize the image to make the text roughly the same size as the paragraph text in articles.
Example (headings for examples are in bold)
Other Notes
Always make sure that you remove any unnecessary whitespace at the end of articles.
If you include links to other articles, set it to open in the same window.
For external links, set it to open in a new window.