🗡️

技術記事を書かないプログラマへ向けた記事

2022/09/14に公開4

はじめに

今回の記事では効率的に技術記事を書くための具体的なテクニックは取り扱わない。技術記事を書くことのメリットや技術記事を書く上で重要なマインドセットを中心に徹底解説する。

要旨:プログラマーは積極的に技術記事を書くべき

私たちプログラマーは積極的に技術記事を書くべきだ。TwitterでもQiitaでもこのZennでも構わない。とにかく何でもいいので、自分の学びや気づきを記録してそれを公開する習慣をつけよう。自分で学んで得られた知識や気付き、新しい価値観をまとめる作業は自分にしかできない。

記事を書くべき理由

記事を書くべき理由はざっくり以下の通り。

  • 知識が定着するから
  • 説明する能力が上がるから
  • プログラマーとしての人となり(興味のある技術やプログラミングに対する価値観、説明する能力など)を知られるから

それぞれ順番に解説する。

知識が定着するから

知識を定着させるための最高の手段は、人に教えることである。

説明する能力が上がるから

人に自分の得た知識や学びを説明することで、自分がまだわかっていないことや曖昧なところ、苦手な部分をより明確にできるのだ。

プログラマーとしての人となりを知られるから

技術記事はプログラマーとしての人となりを知る上では最適なツールである。その人の書いた技術記事を読むことで、その人が興味ある技術やプログラミングに対する価値観を伝えることができるのだ。

記事を書く上で重要なマインドセット

続いて、あくまで個人の見解になるが技術記事を書く上で重要なマインドセットを以下に簡潔に示す。

  • インプットの量を増やす
  • 読みやすい文章を書く
  • 情報の正確性を担保する

それぞれ順番に解説する。

インプットの量を増やす

最初にやるべきことはインプットである。インプットなしでは良質な技術記事を書くことはできない。

私の場合、技術関連でインプットをする場合は主に以下のWebサービスを使い倒す。

例えば、YouTubeであれば気になった動画や面白かった動画は「後で見る」リストに入れて保存したり、Mediumであればストック機能でアウトプットに使えそうな記事や個人的に面白い記事を保存したりすることでインプットの手助けになるだろう。

そのようなものをストックしておくことで、自分専用の備忘データベースが完成する。上記の例で言うと、あとはストックされている記事や「後で見る」リストに入っている動画をいつでも簡単に取り出せるのだ。

読みやすい文章を書く

無事に書きたいことや説明したいことを見つけて記事を書き始めても、特に記事を書き慣れていないと言語化しづらい。技術記事を書く上で、読みやすい文章を書くことを常に心がけよう。

読みやすい文章が重要な理由は、文章の質が記事に対する信用を大きく上下させると考えているからだ。その記事がどれだけ役に立つ内容であっても、誤字脱字や表記ゆれが多い文章はそもそも読んでもらえない。それどころか、読み手に不快な印象を与えてしまう。

重要なことは、「読み手が問題なく記事を読めること」である。「人に伝える」という観点で、ソースコードと文章は同じものだ。文章校正にはできるだけ多くの時間を取って、記事をより多くの人に読んでもらえるように意識しておこう。

情報の正確性を担保する

これが技術記事を書く上でもっとも重要なことだ。いくら時間がかかっても、情報の正確性は担保しよう。ZennやQiitaなどで発信される情報は不特定多数が閲覧できる。その情報が間違っていれば、それに振り回される人は少なからずいる。

記事のもととなる情報は必ず一次情報から取得し、やむを得ず二次情報をもとにした情報であれば十分な検証・テストを実施するようにしよう。より具体的に言えば、プログラミング言語の基本的な文法やフレームワークの使い方などといった具体的なテクニックやハウツーは原則公式ドキュメントから参照するようにしよう。

これを徹底することで、検証やインプットの段階で新しい仮説が生まれたり、関連する情報が出たりするのでより広く深い知識を得られるのだ。より詳しく言えば、「ネタがないから記事を書かない」ではなく「あの知識を得るために記事を書こう」という思考にたどり着けば最強だ。

参考記事

GitHubで編集を提案

Discussion

nyaknyak

マインドセット
批判的、否定的コメントがついてもめげない。新し知識や観点を得る機会だと考える。
(排他的にならず、研究論文みたいに別のやりかた/考え方と相互作用しながら発展していけるととてもいい)

宇宙人A001宇宙人A001

仕事でプログラマーをしている場合、具体的な内容を書く事はできない。
それを一般化まで落としてもあまり意味を感じない。
ネット上にあふれるほどの一般情報(ゴミの近い)を量産することに、個人的まとめ以上に意味があるのだろうか?

マリウスマリウス

問題はQiita含めて技術記事の多くが引用だけしており、(特定)技術の本質を考慮せずに、こう聞いてあるからこうしてくださいという程度に留まるのが多く、よって間違えている情報がかなり多いという実態ですね。
そのような記事が相対的に増えてしまったために、書籍に原点回帰してしまってる問題が理解できる真の技術者が多くなっている事実。
とはいえ、技術力高い人がまじめに簡単な記事を書こうとすると半日程度ノンストップで書くレベルなのでコスパとして割に合わないので面倒くさいから書かないので良記事も増えない事実。
技術者になれてない方はどんどん書いて知識量の確認をして貰い考慮不足を徹底して教えて貰うのは大切ですね。
書くことで無料で教えてくれるのですから。

しぐれ煮しぐれ煮

この記事にすらその情報の正確性が無い。何とか10選みたいな記事が増えてリトリップになっていく。