😊

技術記事を書くための知見

2024/04/20に公開

概要

あまり技術記事に書き慣れていないため、基本的な書き方やマナーを学ぼうと思った。
その学びをこちらにまとめる。

対象読者

  • 技術記事をあまり書いたことがない人
  • 書き方やマナーなどの技術記事の基本を知りたい人

意識すること

1. 既存記事や書籍の丸写しは避ける

丸写しだと、無断転載にみなされる
参考にした書籍を読まなくてもよくなるような内容はNG

2. 未来の自分がわかりやすいように書く

時間を空けてから読んでも理解できるか考える
必要な情報が抜けていないか

3. 凝りすぎない

時間をかけすぎると勿体無い
記事を書けるハードルを下げることで習慣化しやすい

具体的な方法

1. 自分の言葉に言い換える

丸写しを避けるため
自分の言葉で説明できるまで噛み砕いて理解する

2. テーマとなるキーワードを一つにする

いくつもテーマがあると読みづらい
小分けにして出すことで、一つの記事を出すハードルを下げる

3. その記事が役立つ場面や対象読者を提示する

日頃の業務などで共感できるような場面だと、読者は惹きつけられる
閲覧数獲得のテクニックにも思えるが、自分が記事を振り返る時にどういう時に役立つのか明示しておくと便利
過去の自分を対象読者として考えるとよい

4. 重要だと思ったところだけ書く

読みやすいし、丸写しになりづらい

5. 自分の感想を積極的に散りばめる

オリジナリティを出せる
記事を書いたときの自分を思い出しやすそう

6. テンプレートを使う

以下の記事を参考にする
https://zenn.dev/renn/articles/454ea916a29236

参考記事

GitHubで編集を提案

Discussion