良い質問を書くためのガイドライン

このガイドラインについて

Qiitaは、プログラミングに関する知識を記録・共有するためのサービスです。Qiita上の質問は、質問者以外の人にとっても価値のある質問であることが望まれます。

あなたの知識が他の誰かの役に立つようにするために、このガイドラインを参考にしてください。

役に立つ質問を書くために

Qiitaに投稿した質問はフィードに表示され、他のユーザーが目にすることになります。また検索から質問を見つける人もいるでしょう。あなたの質問が読んだ人の役に立つかどうかを意識してみましょう。

自分のトラブルシューティングのための質問でも、少し気をつけるだけでぐっと価値のある質問にすることができます。

意識すると望ましいもの

具体的で簡潔なタイトルをつける

質問のタイトルは、質問のページだけでなくQiitaのフィードやGoogleの検索結果にも表示されます。タイトルを見ただけで質問の中身を想像できるようにしましょう。

具体的なタイトルをつけることで、特定の情報を探している人が質問を見つけやすくなります。

例:

  • 「Rubyについて」→「Rubyの定数探索はスコープと継承関係のどちらが優先されるか」
  • 「正規表現がわからない」→「RubyとJavaScriptの正規表現の違い」
  • 「OpenSSLのバグ」→「CentOS 6.5でOpenSSLのHeartbleedバグの対処法」

環境や前提条件を説明する

質問で取り上げたソフトウェアのバージョンは何か、質問中のコードを実行するためにはどんな手順が必要かを書いておくと、自分の環境に当てはまるかどうかを後から読む人、回答する人が判断しやすくなります。

例:

エラーが発生した時の実行環境はRubyのバージョンが2.3で、Railsは5.1.0です。

また、適切なタグをつけることで質問を見つけやすくなります。

引用元や参考元へのリンクを書く

他のwebページから文章を引用したらそのページへのリンクを張りましょう。そのほか、質問の内容を理解する助けになるページがあればリンクすると親切です。

例:

# 色々な言語で配列の重複を削除する方法

```perl:uniq.pl
sub uniq {
    my %seen;
    grep !$seen{$_}++, @_;
}
say uniq(1, 1, 2, 3, 3);
```

(uniq関数は http://stackoverflow.com/q/7651/454997 より引用)

```ruby:uniq.rb
p [1, 1, 2, 3, 3].uniq
```

(uniqにブロックを与える書き方は http://ruby-doc.org/core-2.2.0/Array.html を参照)

質問を書く前に調べたことについて記載する

質問をするまでに調べた内容については出来るだけ記載するようにしましょう。 そうすることによって、回答者がより回答を行いやすくなります。

例:

調べた時に出てきた記事

- https://qiita.com/Qiita/items/c686397e4a0f4f11683d
- https://qiita.com/Qiita/items/e84f5aad7757afce82ba

質問を書くうえで気をつけること

どんなに役に立つ質問であっても、最低限守らなければならないルールがあります。

著作権に気をつける

自分のものではない文章を引用したり画像を掲載したりするときは、著作権で認められた引用の範囲を超えないように注意しましょう。

ライセンスや秘密保持契約に気をつける

利用にあたっての条件がライセンスで定められている著作物を質問に含めるときは、そのライセンスに従うようにしましょう。

プレリリース版や開発者向けプレビュー版のソフトウェアの中には、秘密保持契約 (NDA; Non-Disclosure Agreement) によって情報の公開が制限されているものがあります。正式公開前のソフトウェアについての質問を書くときは契約を確認しましょう。

利用規約を守る

その他にも、Qiitaの利用規約ではサービスを利用するうえで行ってはならないことを定めています。規約に目を通し、違反することのないようにしましょう。

分からないことがあったら

このガイドラインの内容について不明な点があれば support@qiita.com までお気軽にお問い合わせください。