良い記事を書くためのガイドライン

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

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

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

役に立つ記事を書くために

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

自分用のメモのつもりで書いたものでも、少し気をつけるだけでぐっと価値のある記事にすることができます。

意識すると望ましいもの

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

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

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

例:

  • 「Rubyメモ」→「Rubyの定数探索はスコープと継承関係のどちらが優先されるか」
  • 「正規表現でハマった」→「RubyとJavaScriptの正規表現では複数行モードの意味が違う」
  • 「OpenSSLのバグ」→「CentOS 6.5でOpenSSLのHeartbleedバグにパッチを当てた」

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

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

例:

この記事ではCentOS 6.5にインストールしたRuby 2.2を使っています。
コードを実行するためには http://... で紹介されている設定ファイルが必要です。
コマンドライン引数に与えるユーザー名は適宜読み替えてください。

また、適切なタグをつけることで記事を見つけやすくなります。ある言語やライブラリの特定のバージョンについて話をするときは、タグにバージョンをつけてみましょう。例: Ruby:2.2

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

他の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 を参照)

記事を書くうえで気をつけること

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

著作権に気をつける

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

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

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

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

利用規約を守る

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

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

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