article

saldana-msft avatar image
4 Votes"
saldana-msft Posted · · edited ·

How to: Write a quality question

How to: Write a quality question


Microsoft Q&A envisions the community to deliver timely, high-quality technical answers. Based on our community experience and research, a well-crafted question receives more attention from the community and results in the fastest and the most insightful answers.

This article outlines best practices and guidelines for posting a quality question on Microsoft Q&A which enables the community to deliver swift and reliable answers.
By following these guidelines, you’ll be able to fully utilize a diverse range of contributors on Microsoft Q&A which include veteran MVPs and Partners, Microsoft community experts, Microsoft product group owners, and other users passionate about similar services and problems.



Avoid duplicate questions


Avoid creating threads or questions about problems that have already been asked or answered on Microsoft Q&A and MSDN Forums. To avoid duplication, when you search or ask a question in Microsoft Q&A, you will see related, previously asked questions from both Microsoft Q&A and MSDN Forums. The autosuggestion helps guide you in the following ways:

  • MSDN Forums have a vast knowledge base of good questions and answers. So if the answer is there, we bring it to you to Microsoft Q&A so you save time and get to the answer immediately.

  • By referring to answered threads. Your issue might be resolved without having to create a new thread which saves you a lot of time.

  • If there is an ongoing thread, you can add your question to the existing thread by including details of your scenario. If multiple users report the same issue, the thread will receive more views which increases the amount of attention from the community (and gets a faster solution).


  • If there are no relevant threads, then you can then create a new thread in the appropriate tag topic.

Write a title that summarizes your question


A good title summarizes your scenario and technologies involved. A good title drives readers to really read the thread content in the first place.

Components of a good title: Service – Scenario – Result

  • Service – Service or technology you’re leveraging.

  • Scenario – Skimmed version of the scenario or action you’re trying to accomplish.

  • Result – What is the outcome of your Scenario, mostly an error or you need guidance with a specific scenario.

Examples:

  1. Azure Windows Virtual Machine - Unable to RDP due to authentication error.

  2. Azure WebApp - How do I upload and configure an existing SSL certificate.

  3. Azure IoT Hub – All requests to IoT Hub fail due to an error code 403002 IoTHubQuotaExceeded.


Be concise and informative


To receive a quick and reliable answer to your question, help the community to help you by posting a clear and concise question with all the relevant information to your question or scenario. Share enough details about the problem for the community members to reproduce or correctly understand your issue. This is crucial as it avoids time lost messaging back and forth to fully understand the scenario.

Generally, a quality question consists of the following attributes:

  • Scenario – Describe your scenario and results as well as what you’re trying to solve. Summarize your question in the title effectively. Focus on the what and how in the question content.

  • Technology – Include the technologies involved in your scenario or that you intend to leverage. E.g.: Azure WebApps, Python, code snippet, etc.

  • Result – Share the results of your scenario. Error codes, stack traces, and controls are all very helpful.

  • Environment - Specific scenario requirements, system information, OS or application version, network details, etc.

  • Things you’ve tried: Share any documentation that you’re referring to and list what you have tried to troubleshoot the problem.

  • Screenshot/screencast: If possible, share a screenshot or video for other users to understand your issue better.


Give reproducible steps


If your question can be reproduced by the readers, outline the exact steps and share any documentation that you may be referring for accomplishing the scenario. For programming related questions, the effective way to be specific about a code problem is to provide a minimal bug demonstrating test case. You can share just enough skimmed code for the users to reproduce the scenario which would enable them to share their well-researched recommendations. Ensure that you do not include Personally Identifiable Information (PII).

Ask one question at a time


Do not post multiple questions in the same thread unless the questions are related. Posting multiple questions on the same thread would not help the community to provide greater insight into the problems and can potentially complicate the actual scenario. Based our community experience and research, the users would not be interested in answering a thread with multiple questions. Hence for additional or unrelated questions, create a new question.

Use the right tag for your question


Select the right platform tags to receive answers from the targeted community audience. On Microsoft Q&A, you can add multiple tags relevant for your scenario.


Tags - are topics related to your post that help group and organize all the content on Microsoft Q&A. You can add tags to any kind of post by searching from a wide range of topics at the bottom of a post that you are creating. You can find list of supported tags on the Tags list page.

qna-help-article
· 2
10 |1000 characters needed characters left characters exceeded

Up to 10 attachments (including images) can be used with a maximum of 3.0 MiB each and 30.0 MiB total.

Very good i like so much

1 Vote 1 · ·

Very good guidelines to follow. This was very helpful

1 Vote 1 · ·

Article

Contributors

saldana-msft contributed to this article