こんにちは、rickyです。
ある日所属しているコミュニティで記事を執筆する際に何を書けばいいかという質問を見かけました。
そこでこの記事では私がこれまでどういう意図で書いてきたのかをザックリと書いていきます。
まだ記事を書いたことのない方や記事を書くのに躊躇してしまう方の後押しになれば幸いです。
記事を書く理由
・忘れるから
これに尽きます。
とにかく新しいことが降り積もるIT業界においていちいちすべてを記憶することはできません。
もちろんそれができる方もいるとは思いますが、私は自分のスキルや記憶力に極端に自信がある方でもないのでしょっちゅう忘れます。
そこで忘れた時に自分の記事を見て再現できるように書いています。
そんな時にこのやり方はどうだったかな？という時に記事を見返します。
細かなテクニックやドキュメントのわかりづらい部分を解説した記事を作成しておき、それを読み返すことで再度調べ直す手間を省けます。
では何をどう書くと良いのかを説明します
・問題点
・参考にした情報
・環境
この３つが特に重要です。
問題点
ここはタイトルでわかるようにしましょう。
自分が探す時にも便利ですし何を意図した記事なのかが明確になっていると内容が散らからずに済みます。
あれもこれもと詰め込むのでなくタイトルの要素に必要な内容を漏れなく過剰にならず書くといいでしょう。
参考にした情報
これは極力ドキュメントのそれを引用するようにしましょう。
ドキュメントの内容はまず廃れにくいかつ正確なためまず正しいことが多いです。
ただドキュメントだけでは細かな単語の理解や背景知識までは提供してくれないので適宜個人ブログや別の方の記事を引用しましょう。
環境
意外と見落としがちな観点で環境の情報が抜けてしまうことがあります。
自分の環境をいちいち書くのはやや面倒ですが、書いておくと再現性が高まります。
最後に
記事を書くことは自分への一番の手助けになります。
なぜなら自分の書いた文体というのは何度も見返す上で比較的読みやすいものへと変化していきますしミスしやすい所や詰まってしまうところも大体自分がやるので同じような箇所に収束するからです。
記事の質や評価数を気にしてしまって手が止まってしまったり良い記事を書こうと気負ってしまう方もいるかもしれません。
また技術力のある方から鋭い指摘を受けることを恐れてしまっているのかもしれません。
ただ間違ったことを大っぴらに書いたり、他の技術やスキルをコケにするような文体でない限り大抵の人はそこまで記事に注意を払いません。
質を追求する姿勢は重要ですが記事を執筆するという行為で目立とうとするのではなく、エンジニアの能力は記事を書くことでなく、質の高いシステムの構築やチームのプロダクトに貢献できることの方が重要です。
記事はあくまでそのための一部であって主目的ではないということを意識されるといいでしょう。
記事を書くことは孤独な時間かもしれませんが懸命な姿勢は誰かしらの目に触れるものです。
SNSを通じて書いた記事についてポストや投稿することでそういった方からのアクションが得られやすくなるでしょう。
またもし間違いを指摘していただけるのであればそれは自分のスキルを向上させれるまたとない機会ととらえるのが健全です。
コメントでいきなり威圧的に話しかけてくる方はかなり珍しいですし、また問題提起をするタイミングではほとんどの方が丁寧に言うものです。
もちろん相手の方の意見や考えが自分の中で照らし合わせたものと違っている場合はそのことを率直にコメントしお互いがどうして意見の相違に至ったのかを明らかにすることが大切かと思います。
この記事を読んだ方が記事を書く良いモチベーションを得られたのでしたらこれほど嬉しいことはありません。
ここまで読んでいただきありがとうございました。