技術記事を書くときに考えていること

どこかに書きたかったけど書く場所が無いのでここに書く。

技術記事を書く動機

私の場合、動機は何度か変遷しているが、概ね以下のどれかである。

  • 転職活動を有利に進めるため
    • 私の社会人生活の中ではニッチすぎる言語やレガシーな現場に関わっていたことのほうが多く、「会社で仕事としてやったこと」が転職活動においてアピールポイントになることのほうが珍しかった。そのため世間で需要がある言語などを習得していくために自学自習を行い、またそれを対外的にアピールするために技術ブログを書いていた。
  • 後で内容を忘れたときに思い出すため
    • 使わないことはどんどん忘れるのだが、ブログに書いておくと「ブログに書いた」という記憶はあるので検索することができる。
    • また会社で書いたソースコードは基本的に会社の物であり、プロジェクトを離れたり転職したりすると見返すことは不可能になるので、問題ない範囲で自分がずっと見直すことができる場所に書き写しておきたい。
  • 承認欲求を満たすため
    • これは現職で会社ブログに書けるようになってから発生した動機だが、会社ブログに書くとたくさん「いいね」がもらえてトレンド入りすることもあるので承認欲求が満たされる。

技術記事を書くべきか

「アウトプットしたほうがいいよ！」という話はよく聞くと思うし、私も書いて損することはないと思っている。
でも無理して書くことはないと思う。

文章を書くのには好き嫌いもあるし向き不向きもある。
苦痛を感じてまで技術記事を書くくらいなら、その時間で個人開発でもしたほうがいい。

前項で技術記事を書く動機を書いたが、そもそも根本的に私は文章を書くこと自体が好きなのだ。
これは推測でしかないが、世の中にいる「技術記事を書く」タイプの人は文章を書くことが好きか、少なくとも苦痛ではない人だと思われる。

なぜなら、もし私が「運動」に対して感じている苦痛レベルと同じものを「文章を書くこと」に感じていたとしたら、私は絶対に技術記事を書いていないからだ。
適度な運動が人類に必要であることなどわかっているが、それでも私にとって運動は純粋に苦痛なので、何度となく運動を習慣化しようとして挫折している。

だから技術記事を書こうとして挫折した人がもしいるとしても全然気にしなくていいと思う。

書きたくなったときに書けばいい。

技術記事はどこに書くべきか

個人ブログ

書くハードルの低さとしても、他人に文句言われない意味でも、個人ブログに書くのはおすすめである。
資産を自分の物にするという意味では独自ドメインで運用するともっといい。

  • 自分のためだけに技術記事を書ける人
  • ウェブサイトを運営するのが好きな人
  • 記事のクオリティを気にせず、とにかくアウトプットし続けたい人

は個人ブログがいいと思う。

更に私はかつて存在した「Qrunch」という技術ブログサービスの思想を個人ブログに取り入れ、「記事」「ログ」という分類を設け、「ログ」は検索除けしてあるので、どうでもいいことはログに書いている。
こうしておくと「やったことの個人的なメモ」程度のことを雑に書いても「検索結果が汚れるのでゴミ記事を書くな」派の人から文句を言われないので、精神衛生上良い。

Zenn などのプラットフォーム

Qiita や Zenn のようなプラットフォームは SEO の強さ・書きやすさ等を期待できる。

  • 誰にも見てもらえない環境ではモチベーションを保てない人
  • ブログを運営するという行為が続かない人
  • いつ誰に批判的なコメントを投げられたとしても折れない鋼のメンタルを持っている人

などはプラットフォームのほうが向いているかもしれない。

でもいつかサービス終了する可能性があることは考えておいたほうがいい。
実際、私がかつて使っていた Qrunch はサービス終了した。

技術記事を書くときに気を付けていること

  • 可能な限り公式ドキュメントにリンクを貼る
    • 仮に第三者が書いた記事を参考に何かを実装したのだとしても、その第三者の記事をリンクする他に、一次情報として公式ドキュメントにリンクを貼るのが望ましいと思う
    • 以前在籍した会社では Qiita の記事を会社の Slack に貼ろうものなら上司から DM で「不確かな情報を共有するな」とお叱りを受けるレベルだったので、記事内に一次情報の URL がちゃんと書いてあると助かる人がいる
  • 環境やバージョン情報を書く
    • せめてメジャーバージョンは書いてほしい
  • 可能な限り、ソースコードの断片ではなく全体を共有する
    • 私自身、記事に書いていない部分がわからなくて詰まることが過去に多々あったので、できるだけ全部共有するようにしている
    • 閲覧者がリポジトリを clone して動かすことができるような状態が最も望ましいと考えている
  • タイトルや本文について
    • 煽らない
    • ウケを狙わない
    • 大げさな表現を使わない
    • 名前や用語を正確に使うよう心がける
    • 主語を必要以上に大きくしない
    • 他人の権利を侵害しない
  • Zenn などのプラットフォームに投稿する場合、そのプラットフォーム内において何かしら新規性のある内容にする

以上