Article Editor Formatting Reference

Format an article so readers can locate the answer and follow the steps without relying on its visual layout.

Use headings for the task structure

Use the article title as the main title. Use second-level headings for the main sections and third-level headings only for a subsection. Do not repeat the title as another heading at the start of the body.

For a procedure, useful sections might be Before you start, Create the event and Verify the result. Omit sections that add no information.

Choose the right list

Use a numbered list when actions must happen in order. Use bullets for alternatives or a set of options. Keep explanations next to the step they qualify.

Bold exact interface labels, such as Save, so readers can distinguish a control from an explanation. Use inline code for literal event keys, parameters and values, such as workspace_created.

Add code and links

Put multi-line examples in a code block and select the appropriate language when the editor offers it. Explain which values are placeholders and where the reader gets the real value.

Use descriptive link text such as Install the browser SDK, rather than click here. Link to the maintained article for another task instead of copying the full procedure.

Add an image that explains a step

Place the screenshot beside the action it clarifies. Describe the relevant screen or state in alternative text and add a short caption when useful. Keep the action in the written steps.

Use demo data. Check that credentials, private customer details and unrelated browser tabs are absent. A large full-screen image is less useful than a readable view of the relevant controls.

Verify the public result

Save the article and open View Live when published. Check heading order, numbering, code, links, table width and image readability on desktop and mobile.

If Markdown is used by an agent or integration, check that representation too. Essential conditions should remain attached to the answer when formatting is removed.