Qiita の記事タイトル命名時にコンテキストを明示する

概要

Qiita の記事タイトル命名時にコンテキストを明示することについて

No Context Information

( 非常口が閉まっているんだけど鍵ってどこ？ )

－－－－－－－－－－－－－－－－－－－－－

( 非常口がどうかしたの？今忙しいからあとでね。ガチャ )

With Context Information

( 今オフィスが火事でテラヤバス。非常口が開かないから鍵の場所おしえれ )

－－－－－－－－－－－－－－－－－－－－－

( マジスカ！倉庫のすぐ横にあるッス。すぐに消防車を呼ぶッス )

カテゴリ = コンテキストの明示

Twitter など、Qiita の記事が拡散される際は基本的にタイトルのみで拡散されることになります。
そのため、タイトルだけで何のカテゴリの話か推測出来る必要があります。

タイトル

記事のタイトルに対象カテゴリのキーワードも含めるようにしています。
書いている本人は何のカテゴリか分かって書いていますが、
実際にツイートなどで情報が出まわる際に、タイトルにカテゴリが含まれていないと何の話だか分かりません。

また、フォーマットを決めて情報を発信していると、
読む側が読みやすいのでは？
と思っています。

そのため、基本的に記事タイトルの頭にカテゴリを付与し、
パイプで区切って詳細を記述するフォーマットを愛用しています。

Ruby | アノテーションコメント（TODO、FIXME、OPTIMIZE、HACK、REVIEW）

など。

ただし、記事詳細の出だしもカテゴリと同じ名前から始まっていると繰り返しがうるさい印象になります。

Ruby | Ruby 2.2.0 の新規フィーチャーをネチっこくおさわりする #ruby

そのため、こういった場合はカテゴリのフォーマットを削除しています。

Ruby 2.2.0 の新規フィーチャーをネチっこくおさわりする #ruby

戯言

この手の話は Qiita::Team や esa.io 等を利用したナレッジ共有の際のテクニックの1つとしても役に立ちます。

Qiita::Team や esa.io 等を利用している場合、 Slack や Idobata などのチャットツールと連携しているケースが多いと思います。
その際も、 Qiita から Twitter への通知と同様に、基本的には記事のタイトルが表示されます。
（ツールによっては、タイトルに続く記事内容を一定量プレビューしたりしますが）

タイトルにカテゴリを含んでおくと、通知先のチャットツールで記事の内容を類推しやすくなります。
esa.io は、この手の手法を効率良く行なうのに役立つ機能を複数持っていて、

記事タイトルをスラッシュ区切りにするとカテゴリになる ¹
- 階層化されているため、抽象度の大きいところから記事内容を素早く理解しやすい
投稿テンプレートの利用で、記事タイトル・記事内容ともに体裁を統一しやすい ²

など、使いやすいです。

脚注