「最新の投稿」ページはノイズが徘徊しています。自分用メモというノイズが。
いや、メモを残すのは良いことです。でも、せっかく時間をかけて調べたのに、それを誰も読まないノイズとして世に出してしまうのは勿体無いことでしょう。**どうせなら、もう1手間かけて、「記事」の形で公開してはどうでしょうか?**さすれば、他人の役に立つ可能性が増しますし、上手くすればトレンドに載るかもしれませんよ?
この記事では、私が普段やっている「自分用メモ」を「記事」に進化させるプロセスを紹介し、もっと記事化をみなさんに提案します。
1. 公開しない
いきなり前提を覆しますが、そもそも自分用のメモに過ぎないのなら、世界中に公開する必要があるでしょうか?
記事がネット上に存在するだけで検索のノイズになります。内容に誤りがあれば初心者を惑わせてしまいます。また、「この人は随分雑な投稿が多いなぁ。きっと仕事も雑に違いない」と思われてしまう可能性も無きにしもあらずです。
単にメモをしたいなら、自分のPCに保存するか、Gistなどを使いましょう。非公開なら気兼ねは要りません。
2. 利用シーンを想定する。公式でよくね?
さて、世間的にも需要がある内容であり、記事に仕立てればランキングに載って同僚の評価が上がることが期待できるとします。
まず、誰がどんなときに読むのか想像してみましょう:
- 初心者が全体像を掴むために読む
- 他言語から移ってきてギャップに苦戦する人が読む
- ベテランがド忘れした時に読む
ここで注意したいのがこれです:
「これって公式ドキュメントに載っているよね?公式でよくね?」
今どきのOSSはドキュメントやチュートリアルが充実しています。なぜ、あえて、あなたの記事を読むのでしょうか? ここで利用シーンを上手く想像できないなら実は需要が無かったということです。Gistに書きましょう。
3. コミュニケーションを取る
「記事」は人様に読んでいただくものです・・・などと書くと大げさですが、「自分用メモ」と「記事」は文章の書き方が違います。
ありがちなのは、いきなり説明を始めること。
❌悪い例
rbenv のインストール方法メモ
いきなり書かれても、読者はこの記事は何を言いたいのか? 読み進める価値があるのか? が分かりません。
⭕️良い例
rbenv はRuby開発の標準的ツールですが、プラグインがいっぱいあって1個1個インストールするのは非効率です。そこで、よく使われると思われるプラグインとインストール方法をメモしておきます。
4. 突き詰める
「自分用メモ」を記事に進化させるに当たっては、方向性を突き詰めた方が良い記事になりやすいと思います。
エモい記事はコードを減らして、熱く語りましょう。
チートシート的な記事なら、全ての要素を網羅しましょう。例えば「Pandasのよく使う操作まとめ」ならば、「よく使う操作」は(自分が使わない物を含め)全て書きしましょう。さもなくば「暗記するほど使う機能は載っているが、調べたい機能は載っていない、中途半端なまとめ記事」になってしまいます。
5. 体裁を整える
- 語尾をですます調にする
- 解りやすいタイトルをつける
- 書き出し部分で概要を説明する
- 適当に節を区切る
- 誤字脱字を直す
- いつの時点の情報かを書く
- 処理系のバージョンを書く
- 情報元・公式ドキュメントへリンクを張る
などなど、体裁を整えましょう。特にタイトルや書き出しは大事(らしい)です。この辺りはすでに世間に解説がたくさんあるので、ググってください。
むずび
あなたが困って調べたことは、きっと他の誰かも困っているはず。
みんなで、いい記事をいっぱい書きましょう!