Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 4.75 KB

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

File metadata and controls

73 lines (55 loc) · 4.75 KB
title description services documentationcenter author manager editor tags ms.service ms.devlang ms.topic ms.tgt_pltfrm ms.workload ms.date ms.author
Page title that displays in the browser tab and search results
Article description that will be displayed on landing pages and in most search results
service-name
dev-center-name
GitHub-alias-of-only-one-author
manager-alias
comma-separates-additional-tags-if-required
required
may be required
article
may be required
required
mm/dd/yyyy
Your MSFT alias or your full email address;semicolon separates two or more

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.

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

[!INCLUDE learn-about-deployment-models]

[!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”.

If it is an article on the billing topic, include the following note (the note below is slightly different than the one at the bottom of this article):

Note

If you need more help at any point in this article, please contact support to get your issue resolved quickly.

If it is NOT a billing article, use the following reference: [!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.
Note: VM articles for ARM exceptions and should not use the ARM/Classic selector.

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.

If it is an article on the billing topic, include the following note (the note below is slightly different than the one at the beginning of this article):

Note

If you still have further questions, please contact support to get your issue resolved quickly.