Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 4.3 KB

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

File metadata and controls

62 lines (44 loc) · 4.3 KB

Title (Maximum 120 characters, target the primary keyword)

Use 2-3 secondary keywords in the description.

Select one of the following disclaimers depending on your scenario. If your article is deployment model agnostic, ignore this.

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

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

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

Summary (Optional, especially when the article is short)

  • Briefly describe the problem.
  • The Summary section is a good place to use different keywords from those in the title, but make sure to not make it very wordy. The sentences should flow well and be easy to understand.
  • Exceptions (optional) - List the relevant scenarios that are not covered in this article. For example, ” Linux/OSS scenarios aren't covered in this article”.

[AZURE.INCLUDE support-disclaimer]

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.

Solution

  • Add screenshots if possible.
  • If there are multiple solutions, put them in the order of complexity and provide instructions on how to choose from among them.
Version 1: Your article is deployment model agnostic Version 2: Steps for Resource Manager and Classic are largely the same Version 3: Steps for Resource Manager and Classic are mostly different.
In this case, use the Simple Selectors technique in Github.

Solution 1

(the simplest and most effective)

  1. [Step 1]
  2. [Step 2]

Solution 2

(the less simple or effective)

  1. [Step 1]
  2. [Step 2]

Solution 1

(the simplest and most effective)

  1. [Step 1]
  2. If you use the classic deployment model, [do this].
    If you use the Resource Manager deployment model, [do this].
  3. [Step 3]

Solution 2

(the less simple or effective)

  1. [Step 1]
  2. If you use the classic deployment model, [do this].
    If you use the Resource Manager deployment model, [do this].
  3. [Step 3]
 ARM-Classic

Solution 1

(the simplest and most effective)

  1. [Step 1]
  2. [Step 2]

Solution 2

(the less simple or effective)

  1. [Step 1]
  2. [Step 2]

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 a list of links. If you include links to next steps, make sure to include text to explain why the next steps are relevant/ important.