More than 3 years have passed since last update.

Qiita記事投稿のドキュメンテーションテクニック

Last updated at 2020-12-22Posted at 2020-08-09

はじめに

　苦労して書いたQiita記事を少しでも多くの人に届けるための、ちょっとしたテクニックのまとめです。いつも忘れちゃうので半分は個人的メモです。直接プログラミングには関係ないですが、ドキュメント作成技術もソフトウェア技術の1部ということでご容赦下さい。

　記事を各画面の右上に、絵文字アイコンやヘルプアイコンがあります。ど忘れしちゃったときに結構便利です。

　絵文字に関してはEMOJI CHEAT SHEET、Qiita/Github/Slack/Discord 絵文字一覧を参照しても良いでしょう

　また、ヘルプ（？マークのアイコン）リンク先のMarkdown記法チートシートは一度は目を通しておくと良いと思います。何かしらの新しい発見があるかと思います。

　Markdown記法チートシートに書いてありますが、テーブル作りたいとき便利です。3x2とか作りたいテーブルのサイズを入力するだけで、勝手にベースを作ってくれます。

　こちらのアニメGIFはMarkdown記法チートシートからの引用です。

　GitHubのリポジトリへのリンクは、以下のようにOGPっぽいリンクを貼ると目立って良いです。

　GitHub Link Card Creatorというサービスを使うことで実現できます。

　使い方は簡単で <GitHub user name>/<GitHub repository name>を入力するだけです。上記のリンクだと karaage0703/uonomeです。

　作者による、サービス作成の経緯などは以下記事参照ください。

　禁断の技？かもしれません。~~Qiitaにログインしている必要があります。~~ ログインしないで見る方法をTwitterで教えていただきました。

「あ、このQiita記事素敵…これは恋かも。もっとこの記事のこと知りたい！」

　と思ったら、ラブレターならぬ編集リクエストを送りましょう。記事の右上の「…」をクリックすると、以下のように出てくる「編集リクエストを送る」をクリックします。

　と思ったら、記事の右上の「…」をクリックすると、以下のように出てくる「Markdownで本文を見る」をクリックします。

　すると、あら不思議（？）Qiita記事のソースが丸裸！参考にしちゃいましょう！

　もちろん、引用を超える範囲のコピーはダメです。気をつけましょう。

　Qiitaでは数式も使えます。詳しくは以下参照ください。

　Qiitaに記事投稿するときの、ちょっとしたドキュメンテーションのTIPSを書きました。

　もちろん一番大切なのは中身なのですが、ちょっと工夫すると読者も自分自身も読みやすくなって良いなと思います。良いQiita記事の増加にこの記事が少しでも役立てば嬉しいです。