Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 2.98 KB

new-markdown-template-for-support-articles-troubleshoot.md

File metadata and controls

69 lines (53 loc) · 2.98 KB
Raw

Title (Maximum 120 characters, be keyword rich to match what users use to describe the problem)

Opening paragraph

  • Briefly describe the specific issue this article can help troubleshoot, and the common root causes.
  • Set the expectation: What users can achieve when they finish the article.
  • Don’t have more than one Note element at the top.
  • The opening paragraph is a good place to place keywords. But avoid stuffing keywords but let the content flow in a natural way.
  • Exceptions (optional) - List the relevant scenarios that are not covered in this article. For example, you describe that the Linux/OSS scenarios aren't covered.

How to use this article (optional)

  • Used when the article is long to help describe what all is there and how it's organized. Intent to help customer as a guiding para to decide where to jump to or start within the doc.

[AZURE.INCLUDE support-disclaimer]

Select one of the following disclaimers depending on your scenario.

[AZURE.INCLUDE learn-about-deployment-models] classic deployment model.

[AZURE.INCLUDE learn-about-deployment-models] Resource Manager model.

[AZURE.INCLUDE learn-about-deployment-models]

Background information (Optional)

  • Background information that needs to be understood before continuing.

General troubleshooting steps

Steps for the classic deployment model

  1. step 1.
  2. step 2.
  3. step 3.

Steps for the Azure Resource Manager deployment model

  1. step 1.
  2. step 2.
  3. step 3.

Detailed troubleshooting steps

Steps for the classic deployment model

  1. step 1.
  2. step 2.
  3. step 3.

Steps for the Azure Resource Manager deployment model

  1. step 1.
  2. step 2.
  3. step 3.

Next steps

Include this section if there are 1 -3 concrete, highly relevant next steps the user should take. Delete if there are no next steps. This is not a place for lists of links. If you include links to next steps, make sure to include a bit of text helping the user understand why the next step is relevant and important.