🎖️

技術記事を書くときに心がけている『3つのシンプルさ』

2021/02/07に公開

記事はシンプルでないと、本当に伝えたいことが伝わりません。

そのために、私は『3つのシンプルさ』を大切にしています。

3つのシンプルさ

読者が本当に欲している情報を考え、それ以外の情報はなるべく削ります。

Vueの記事でReactの書き方をついでに紹介したい気持ちもわかりますが、
比較記事以外では必要ないかなと。

どうしても他の話題に言及したい場合は、リンクを貼る程度にしましょう。

『Reactでの書き方は以下の記事で紹介しています。そちらもあわせてどうぞ！』
URL:XXX

『〜であると考えられるのではないでしょうか』
『〜という場合もありえるかなと思いますので』

みたいな表現、ついつい使ってしまいがち。特にフォーマルな文章を書く時。
丁寧な文章にすることは大事ですが、技術記事で敬語を厳しく見ている人はいません。

『〜とも考えられます』
『〜な場合もあるので、』
くらいの短さに変換して言い回しをシンプルにしましょう。

扱うテーマについて、すべてを網羅する必要はないでしょう。
そういった体系的な知識は記事よりもZenn本のほうが適切です。

例えば、プラグインの導入の記事を書くとしても、
オプションをすべて紹介する必要はないのです。

私は潔く、
「便利なオプションの数々は公式が分かりやすいので、そちらを見てください！」
と割り切ってリンクを貼っています。

なぜなら、その記事はあくまで
『便利なプラグインがあることを知ってもらう』
『かんたんに導入してもらう』
ことが目的だったからです。

『記事の目的はなにか』 をもう一度見直して、脱線しないようにしましょう。

とは言いつつも、ついつい私も冗長な表現や、余計な情報を入れてしまうことがあります。
記述ルールに体力を使いすぎたらアウトプットが習慣化しないので、
本当はもっと気楽に書いていいです。

ただ、シンプルになるだけで内容はとても伝わりやすくなります。
今日からちょっとだけシンプルさを意識して技術記事を書いてみましょう。