Skip to main content

User Doc Troubleshooting Template

User doc teams to follow this template to write a topic on troubleshooting.

Note: Ensure that you link to the troubleshooting topic either after the step or at the end of the task so the user benefits from the information.

Markdown template

Copy the contents to an empty markdown file and start editing. Remove the help text in block quotes and any unused sections. Note: The frontmatter yaml provider in this template follows Docusaurus requirements but can be skipped or replaced with the format used by your preferred tool.

---
tags: ["Product","Component","Troubleshoot"]
title: "Add Topic title"
sidebar_label: "Title used for the sidebar"
slug: topic-slug
sidebar_position: number that dictates the placement of topic in the sidebar
description: Short description abou the topic
last_update:
date: DD/MM/YYYY
author: Author Name
---

Provide a brief description about the problem statement.

## Condition

Describe a condition or symptom that is associated with an undesirable state in a system, a product, or a service. In cases where the topic title fully explains the condition, do not use this element.

## Possible cause(s)

Describe a possible cause for the condition

## Remedy/solution

List the possible solutions to the condition.

Owner: Documentation Management Team