---
title: Troubleshooting
description: Write effective troubleshooting documentation.
image: https://developers.cloudflare.com/cf-twitter-card.png
---

> Documentation Index  
> Fetch the complete documentation index at: https://developers.cloudflare.com/style-guide/llms.txt  
> Use this file to discover all available pages before exploring further. 

[Skip to content](#%5Ftop) 

# Troubleshooting

This troubleshooting strategy outlines our approach to troubleshooting content that is specific to a product or platform.

## Purpose

The purpose of Troubleshooting content is to provide guidance for solving common and corner-case problems with the product.

## Tone

Guiding, straightforward, solution-oriented

## content\_type

YAML

```
pcx_content_type: troubleshootingproducts:  - product-a  - product-b  - product-c
```

For more details, refer to [pcx\_content\_type](https://developers.cloudflare.com/style-guide/frontmatter/custom-properties/#pcx%5Fcontent%5Ftype).

## Structure

### Required components

[**Title**](https://developers.cloudflare.com/style-guide/documentation-content-strategy/component-attributes/titles/): Troubleshooting name of product or feature

### Optional components

[**Context**](https://developers.cloudflare.com/style-guide/documentation-content-strategy/component-attributes/context/)

[**Steps/Tasks/Procedures**](https://developers.cloudflare.com/style-guide/documentation-content-strategy/component-attributes/steps-tasks-procedures/)

[**Examples**](https://developers.cloudflare.com/style-guide/documentation-content-strategy/component-attributes/examples/)

**Next steps**

## Template

```
---weight: xxpcx_content_type: troubleshootingdescription: Troubleshoot common <Cloudflare product or feature> issues, including <key error types or symptoms>.products:  - product-a  - product-b  - product-c---
# Troubleshooting
An introductory paragraph is not required but may be worthwhile if there is a lot of information on this page.
## Concise noun title
Explanation of how to address this issue.
## Concise noun title
Explanation of how to address this issue.
```

## Additional information

In general, create a unique Troubleshooting section for your product. If the Troubleshooting steps are minimal, include the guidance on one Troubleshooting page.

If there are several Troubleshooting steps, create separate pages for logical groupings of Troubleshooting.

```json
{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/troubleshooting/#page","headline":"Troubleshooting · Cloudflare Style Guide","description":"Write effective troubleshooting documentation.","url":"https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/troubleshooting/","inLanguage":"en","image":"https://developers.cloudflare.com/cf-twitter-card.png","dateModified":"2026-04-24","publisher":{"@type":"Organization","name":"Cloudflare","url":"https://www.cloudflare.com/"},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}
{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/style-guide/","name":"Style Guide"}},{"@type":"ListItem","position":3,"item":{"@id":"/style-guide/documentation-content-strategy/","name":"Product docs content strategy"}},{"@type":"ListItem","position":4,"item":{"@id":"/style-guide/documentation-content-strategy/content-types/","name":"Content types"}},{"@type":"ListItem","position":5,"item":{"@id":"/style-guide/documentation-content-strategy/content-types/troubleshooting/","name":"Troubleshooting"}}]}
```