見出し画像

ITエンジニア向けに記事を書く時の心得

職業「戸倉彩」＠女性を理由に、ITエンジニアを諦めない人生🥑

こんにちは。職業「戸倉彩」です。
皆さんの中で、アウトプットの一つとして記事を書くことが習慣になっているITエンジニアの方はどれくらいいるでしょうか？
技術について「知っている」→「理解している」→「説明できる」とステップアップし、自分の言葉で記事を書くことを目標にすることは、エンジニアのスキル向上にとても効果的です。また、学習履歴の管理や、技術の発展への貢献にも繋がります。今回は、ネット上で技術ブログや技術的なドキュメント等を書く際にワタシ自身が常に心得えていることをご紹介します。

1. 技術的な記事の種類について理解しておく

現在、誰でも記事を書いて公開できるサイトやサービスが増えていますが、書きたいことを書く前に、どんなタイプの記事を書きたいのかを明確にしておくと良いでしょう。

■代表的な技術記事の種類
・ニュース記事
・技術評論記事 (技術に関する意見やレビューなど)
・技術解説記事 (◯◯◯とは、◯◯◯との比較や違いなど)
・まとめ記事 (ランキングなど)
・翻訳記事

2. 書くことそのものに慣れる

文章を書く時に必要なのは、言葉にまとめる力です。文章を書くスピードや量には個人差があるので、仮に時間がかかったとしても焦らないようにしましょう。書くことを「習慣」にすることで、成果は必ず上がる！と信じて、継続するのが一番です。

3. コードを書く事との共通点

「記事を書くコツ」については、ネットや書籍ですでに多くの情報が提供されているので確認することが可能です。書くための活動を続けていると、独自に気づきや学びを得られるケースがありますが、ワタシの中では途中からエンジニアの視点で、コードを書く時と共通すると感じた点として心得ていることがいくつかあるので下記にリストしておきます。

1. 第三者が読んでも理解できるように務める
2. 書く量をコントロールする
3. 適切に分割して関数(項目)にする
4. デバッグ(誤りを見つけ手直し)やアップデート(更新)に不向きなコード(文章)にしない
5. 自分が作ったものに責任を持つ

4. 記事を書く時はウォータフォール型？アジャイル型？

すでに、技術ブログなどを書かれている方は、ソフトウェア開発する時の開発手法で例えると、計画と立てて上から順番に書いていく「ウォーターフォール型」でしょうか？変化への対応を前提としながら各パートに分けて「アジャイル型」でしょうか？先日、ちょっと気になったのでTwitterで簡易的なアンケートを実施してみました。

アジャイル型のほうがウォーターフォール型より多い結果となりましたが、その他も多かったことから次のような流れで書いている方も多いのかもしれません。ご自身に合った進め方を見つけて、攻略できるのが良さそうです。ちなみにワタシはケースバイケースで手法を使い分けて書いています。

いかがでしたでしょうか。過去にコミュニティメンバーと一緒に同人誌「ブログを書こう: ブログを書く技術 (Kindle版)」を作りましたので、こちらも合わせて参考にしていただけると嬉しいです。


この記事が気に入ったらサポートをしてみませんか？