You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cassandra.apache.org by Erick Ramirez <er...@apache.org> on 2022/04/05 13:38:14 UTC

[DISCUSS] Proposed guide to asking good questions in Community channels

I was chatting to Bowen Song a couple of weeks ago and we stumbled on the
topic of "low quality questions". They're the kind of questions that
usually lack information and/or context that make them difficult to answer.
As much as we hate it, we end up answering these questions with a bunch of
other questions.

Bowen and I talked about the idea of drafting a one-page document so there
is some sort of a minimum standard (for lack of a better expression) when
asking questions. The outcomes we are striving for are:

   - community is more inclined to respond
   - users hopefully get faster responses
   - users hopefully get better answers
   - the project has a higher community engagement from better user
   experiences

For the record, the idea is NOT to be prescriptive and NOT to act as a
hurdle to users. It is there to serve as a guide.

The draft is available for review/feedback/comment here
<https://docs.google.com/document/d/1-ZYpl9tif9OAMdAxFLxA1mTPNp0zkNW4kzXvfvRBHUc/edit?usp=sharing>.
Here's the TL;DR --

   - use a meaningful title or subject line
   - explain the problem you're trying to solve
   - provide background info + workarounds you've already tried
   - list software versions: C*, driver, Java, etc
   - provide full error message + full stack trace
   - provide configuration details
   - include table schema + full CQL query
   - include minimal code which reproduces the issue

I'm proposing to publish the document as a sub-page of the Community
<https://cassandra.apache.org/_/community.html> section of the website. I
plan to send periodic notifications to the user ML and the ASF Slack
channels to let users know of its existence.

We're looking forward to your feedback. Cheers!

Re: [DISCUSS] Proposed guide to asking good questions in Community channels

Posted by Mick Semb Wever <mc...@apache.org>.
This is a solid initiative Erick, very much appreciated.

On Tue, 5 Apr 2022 at 18:37, Ekaterina Dimitrova <e....@gmail.com>
wrote:

> I like the idea, sometimes new users just don’t know where to start and
> what/how/where to ask so this guidance sounds very helpful to me! Thank you
> Bowen and Erick!
>
> On Tue, 5 Apr 2022 at 9:38, Erick Ramirez <er...@apache.org>
> wrote:
>
>> I was chatting to Bowen Song a couple of weeks ago and we stumbled on the
>> topic of "low quality questions". They're the kind of questions that
>> usually lack information and/or context that make them difficult to answer.
>> As much as we hate it, we end up answering these questions with a bunch of
>> other questions.
>>
>> Bowen and I talked about the idea of drafting a one-page document so
>> there is some sort of a minimum standard (for lack of a better expression)
>> when asking questions. The outcomes we are striving for are:
>>
>>    - community is more inclined to respond
>>    - users hopefully get faster responses
>>    - users hopefully get better answers
>>    - the project has a higher community engagement from better user
>>    experiences
>>
>> For the record, the idea is NOT to be prescriptive and NOT to act as a
>> hurdle to users. It is there to serve as a guide.
>>
>> The draft is available for review/feedback/comment here
>> <https://docs.google.com/document/d/1-ZYpl9tif9OAMdAxFLxA1mTPNp0zkNW4kzXvfvRBHUc/edit?usp=sharing>.
>> Here's the TL;DR --
>>
>>    - use a meaningful title or subject line
>>    - explain the problem you're trying to solve
>>    - provide background info + workarounds you've already tried
>>    - list software versions: C*, driver, Java, etc
>>    - provide full error message + full stack trace
>>    - provide configuration details
>>    - include table schema + full CQL query
>>    - include minimal code which reproduces the issue
>>
>> I'm proposing to publish the document as a sub-page of the Community
>> <https://cassandra.apache.org/_/community.html> section of the website.
>> I plan to send periodic notifications to the user ML and the ASF Slack
>> channels to let users know of its existence.
>>
>> We're looking forward to your feedback. Cheers!
>>
>

Re: [DISCUSS] Proposed guide to asking good questions in Community channels

Posted by Ekaterina Dimitrova <e....@gmail.com>.
I like the idea, sometimes new users just don’t know where to start and
what/how/where to ask so this guidance sounds very helpful to me! Thank you
Bowen and Erick!

On Tue, 5 Apr 2022 at 9:38, Erick Ramirez <er...@apache.org> wrote:

> I was chatting to Bowen Song a couple of weeks ago and we stumbled on the
> topic of "low quality questions". They're the kind of questions that
> usually lack information and/or context that make them difficult to answer.
> As much as we hate it, we end up answering these questions with a bunch of
> other questions.
>
> Bowen and I talked about the idea of drafting a one-page document so there
> is some sort of a minimum standard (for lack of a better expression) when
> asking questions. The outcomes we are striving for are:
>
>    - community is more inclined to respond
>    - users hopefully get faster responses
>    - users hopefully get better answers
>    - the project has a higher community engagement from better user
>    experiences
>
> For the record, the idea is NOT to be prescriptive and NOT to act as a
> hurdle to users. It is there to serve as a guide.
>
> The draft is available for review/feedback/comment here
> <https://docs.google.com/document/d/1-ZYpl9tif9OAMdAxFLxA1mTPNp0zkNW4kzXvfvRBHUc/edit?usp=sharing>.
> Here's the TL;DR --
>
>    - use a meaningful title or subject line
>    - explain the problem you're trying to solve
>    - provide background info + workarounds you've already tried
>    - list software versions: C*, driver, Java, etc
>    - provide full error message + full stack trace
>    - provide configuration details
>    - include table schema + full CQL query
>    - include minimal code which reproduces the issue
>
> I'm proposing to publish the document as a sub-page of the Community
> <https://cassandra.apache.org/_/community.html> section of the website. I
> plan to send periodic notifications to the user ML and the ASF Slack
> channels to let users know of its existence.
>
> We're looking forward to your feedback. Cheers!
>