技術記事ってどう書けばいいの？って悩みを解決するために改めて技術記事の書き方を学んだ

下記の記事を読みました。

syu-m-5151.hatenablog.com

これまでただ適当に、メモ書き程度に記事を書いていましたが、ちゃんと記事を書けるようになっておきたい、自分なりの方法を確立してみたいと思ったので、改めて学んでみようと思いました。

そろそろちゃんと記事を書く習慣をつけたい……。

そもそも技術記事とは？

そもそも大前提、この定義をしていなかったので改めて定義してみます。筆者によると、

技術ブログは、完璧な知識や完成された思考を示すためのものではありません。 それは思考の過程を記録するもの です。完璧を目指すあまり書けなくなるよりも、不完全でも自分の観察と気づきを残していくことに価値があります。

としています。このAI全盛期の時代は、AIに聞けば迅速に求めていた答えが手に入れられます。わざわざ、検索窓にキーワードを入れて、リンクをクリックして、みたいな工数を踏むこと自体少なくなっている気がします。なので、完璧な知識、まぁ誤っているものもあるので絶対完璧とは言えないのですが、はAIに任せて、我々人間はどのように考えたかという経験を記述しようよという感じ。

ネット上には膨大な情報があふれていますが、だからこそ、あなたの視点、あなたの言葉、あなたの経験を通して伝えられる情報には価値があります。なぜなら、あなたの記事を必要としている人は、まさにあなたと同じ疑問や課題を持っている人だからです。

と筆者も言っていますしね。やはり経験 > 知識になってきているんだなと。

ですので、私は技術記事の定義を、技術に関する個人の経験を記述したものということにします。

技術記事は著者にどのような恩恵をもたらすのか？

筆者によると記事を書くことは下記のような恩恵があるとしています。

思考の整理と知識の定着：記事を書くことで自分の思考を言語化でき、さらに知識の定着を促す
知識の共有経済への参加：自分の経験を共有することで他者貢献につながり、業界全体の発展へつながる
思考や成長の可視化：記事を見返すことで思考や成長のプロセスを可視化できる

記事を書くことによって、個人的成長と他者貢献のどちらもできるわけです。

どのようなテーマの記事を書けばいいのか

記事では

学習ログ
環境ガイド
プログラミングの乗り換え
バグハント
学んだ教訓
システム開発

の6つを記事の種類として挙げています。詳しい書き方は記事を参考にしてもらえばいいと思いますが、自分が最も書くであろうジャンルは「学習ログ」なので、こちらをまとめます。

学習ログの書き方

学習ログは最も手っ取り早く書けるため、そこら中にありふれています。なので、知識を解説するよりも経験に沿って書いていきます。記事では学習ログを書く際のポイントを、

学習の目的と背景を明確に
つまづきとその解決方法を詳細に
公式ドキュメントに書かれていない気づきを強調する
スクショやコードスニペットを使って手順を明確に

としています。ここでも自分の思考と経験にフォーカスを当てて記事を作成するのがポイントになりそうです。

自分であれば、エンジニアからDX推進者へジョブチェンジをして、扱う技術がCSharp|C#からMicrosoft Power Appsに変わりました。ですので、この新しい技術をどう学んでいったか、エンジニア時代の学習経験をそのまま活かせたのかなどを中心にまとめていくと経験を中心にした独自の記事になると考えられます。