Troubleshooting Layout

All Spectro Cloud troubleshooting guides are expected to have the same look and feel. The troubleshooting text and voice must adhere to the Spectro Cloud style guide for a universal look and feel. The guide must also feel familiar to the reader. Therefore, all troubleshooting guides must follow the layout standard described on this page.

Table of Contents

Markdown Layout

Section Breakdown

Markdown Layout

The following is a high-level overview of the markdown structure that all troubleshooting guides must contain. Take note of the markdown heading sizes.

# Scenario - <Insert Short Scenario Name>

<Intro paragraph with an overview of the scenario and cause.>

## Debug Steps
<Step 1 ...>
<Step N ...>

Section Breakdown

Section	Description
Scenario (Title)	The name assigned to the troubleshooting scenario. Aim for a brief title, ideally less than five words.
Intro Paragraph	The introduction sets the context for the troubleshooting guide and explains the issue.
Debug Steps	The step-by-step flow of how to address the issue or how to identify the problem.