What should I include when asking a question?

  • 4 June 2021
  • 0 replies
  • 133 views

Userlevel 3
Badge +7
  • Developer Support Engineer
  • 80 replies

The community is a great way to get support for any issue you’re facing, but for others to help you, it’s important to help yourself as well! To improve your chances of getting the best answer quickly, we’ve summarized some tips from Stackoverflow’s excellent article on how to ask a good question: stackoverflow.com/help/how-to-ask

 

Search, and research

Links to related questions that haven’t helped can help others in understanding how your question is different from the rest
 

Write a title that summarizes the specific problem

  • Bad: Customer timeline bug
  • Good: How can a renewal still occur after an unsubscribe on iOS?

Make it as easy as possible for others to understand what you’re looking for in an answer.
 

Be descriptive, include details

The more information you provide, the more likely someone will be able to help answer your question quickly. Think to yourself, what information could I provide that might help someone answer my question?

If possible, try to include information like:

  • Debug logs
  • SDK and version (e.g. Native iOS 3.11.0, React Native 4.1.2)
  • How you’ve tried to resolve your issue

Of course, this isn’t an exhaustive list- but it’s a great start!
 

Be organized

  • DO NOT post images of code, data, error message, etc. - copy or type the text into the question. This makes it a lot easier for others to do the same.
  • DO post image for diagrams or screenshots of things that are impossible to describe accurately via text. A picture can be worth 1000 words.
  • For long logs, consider uploading a .txt file with the full log output, and only post relevant log messages in the question. The full log output may contain useful information regarding your question, even if it doesn’t seem like it initially.
     

Example

Let’s try an example. Take a look at this question:
 

‘Purchases aren’t working, how do I fix it?’

 

It’s clear that the community wouldn’t be able to be effective with a response here, and it would likely require several more responses to get the necessary information to actually be helpful.

We’re missing a lot of crucial information here, like:

  • What platform are you using?
  • What SDK version are you using?
  • What behavior are you experiencing vs what are you expecting to happen?
  • Do you have debug logs that reproduce the issue?
  • Have you searched the community for related questions?

You get the idea!
 

Summary

Your question is more likely to be answered if you provide as much information as possible. The community and RevenueCat team here are helpful, but we can only go as far to help you as you let us! Be thorough and deliberate with your questions so we can get you back on track as soon as possible.


This post has been closed for comments