Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.78 KB

new-markdown-template-for-support-articles-cause-resolution.md

File metadata and controls

68 lines (51 loc) · 2.78 KB
Raw

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

Summary (Optional when the article is short)

  • Briefly describe the problem.
  • Set the expectation: What users can achieve when they finish the article.
  • Don’t have more than one Note element at the top.
  • The Summary section 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.

[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]

Symptom

  • What actions would the user be trying to complete?
  • What failed?
  • What systems and software would the user have been using?
  • What error messages could have been shown?
  • Include screenshot if possible

Cause

  • What causes this problem.
  • If the cause is more technical than the technical level of the article, put it in the More information section.

Resolution

  • Add screenshots if possible.
  • If there are multiple resolutions, put them in the order of complexity and provide instructions on how to choose from among them.

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.