技術ブログを書こう2022_公開版

1.2K Views

November 21, 22

スライド概要

社内で実施した、技術ブログ勉強会の資料の公開版です。

シェア

埋め込む »CMSなどでJSが使えない場合

各ページのテキスト
1.

技術ブログを書こう 2022 技術ブログ勉強会 2022/11/12 株式会社エーピーコミュニケーションズ エンジニアリングメンター室 横地 晃 1 Photo by Bram Naus on Unsplash

2.

はじめに 年々、APCでもブログを書く方が増えていて、公式の技術ブログの 投稿頻度も高くなっています。 また、アドベントカレンダーやアウトプットを求められるプロ職の申請 も始まる季節です。 そんな中、ブログを書いてみたいけどいまいち自信がないんだよな ・・という方もいらっしゃるのではないでしょうか。 何をどう書けばいいか分からない、続かないなどの悩みについて、 私なりにお答えします。 ※全体的に自己流が中心です 2

3.

自己紹介 横地 晃 エンジニアリングメンター室 兼 ACT @akira6592 2012年 APC入社 2016年 Qiita、Twitter 開始 2017年 プロフェッショナル職へ転向 技術ブログ「てくなべ」開始 2018年 テクニカルエバンジェリスト職へ転向 2022年分 61記事 (11/18現在) 2021年分 46記事 2020年分 175記事 https://tekunabe.hatenablog.jp/ 3

4.

本日の内容 ● ● ● ● なぜ書くのか 何を書くのか どうやって書くのか どうやって続けるのか 4

6.

あなたは 何のために ブログを 書きますか? 6

7.

自分のため 7

8.

自分のため ● 知識を整理する ○ 口頭説明できても文字にできないことありませんか? ● ググれるカンペをつくる ○ 書いて忘れて、別のことに脳を使う 8

9.

自分のため ● フィードバックを得る ○ 情報は発信するところに集まる ○ 間違いの指摘は学習のきっかけ ● 自分の分身をつくる ○ ブログのURLだけで情報伝達できる 9

10.

他人のため 10

11.

他人のため ● Give & Take ○ 自分も他人のアウトプットで仕事している ○ ならば自分もアウトプットしよう 11

12.

とはいえ・・ 12

13.

ブログへの壁 ● 需要がなさそうで書けない? ○ 需要は書いてから測ろう ○ そもそも誰のためか ● 指摘が怖くて書けない? ○ 勘違いのままとどちらが怖いですか? ○ ただし精神の安定は必要 ○ 公開範囲を調整する 13

14.

最初はメモでもいい 技術ブロガーを育てる!ブログメンタリングで何を教えているのか https://speakerdeck.com/kakakakakku/passion-for-blog-mentoring? @kakakakakku #ブログメンタリング 14

15.

公開範囲と特徴 公開範囲 安心感 フィードバック 非公開 ◎ ☓ 組織内公開 ◯ ◯ 社外公開 ☓ ◎ 15

17.

今日 ググって得た情報は何 ですか? 17

18.

考え方 ● 普段ググってどんな情報に出会って いるかふりかえってみる ○ 意外と小ネタが多いのでは ○ 役に立ちましたよね? ● 調べ事はブログネタになる ● 自分が読みたいことを書く 18

19.

具体例1 ● チュートリアル ○ 面白そうなツール、機能 ○ 環境設定 ● トラブルシューティング ○ エラーメッセージの原因と対処 ○ ハマったこと、解決できずに悩んでいること 19

20.

具体例2 ● スキマを埋める情報 ○ 日本語でまだない情報 ○ 公式ドキュメントで微妙に不足している情報 ○ 既存の古い情報が今も通用するか検証する ● 日記 ○ 資格の勉強日記 ○ 初心者ならではのつまずき日記 20

21.

具体例3 ● 経験談 ○ うまくいったこと ○ うまくいかなかったこと ● 考え方、意見、感想 ○ 新しい考え方 ○ 新しくないけど言語化されていないこと ○ イベント参加レポート 21

22.

軸は色々、優劣は無い 古い 新しい 初心者ならでは 上級者ならでは 知識 経験 失敗 成功 狭い 広い 浅い 深い おもしろい まじめ 22

23.

今のあなたにしか書けないことがある ・不安 ・つまずき 初級者 忘れている 分からない ・ノウハウ ・勘 上級者 成熟度 23

25.

始め方 25

26.

始め方(参考) ● ● ● ● 大体のテーマを決める、けどあまりこだわらない 利用するブログサービスを決める SNSアカウントを準備する ブログを書く、SNSで共有、の繰り返し ○ 最初の記事に迷ったら ■ 自己紹介 ■ 興味のある技術分野 ■ これから何を書くか 26

27.

ブログ系サービスの選び方 はてなブログなど Qiita Zenn ◯:技術が中心 ◎:Tech or Idea ◎:何でも可 フィードバック ◎:得やすい ◎:得やすい △:最初は得にくい 手軽さ ◎:かんたん ◎:かんたん ◯:名前決め等が必要 ◯:アカウントレベル ◯:アカウントレベル ◎:ブログレベル テーマ アイデンティティ Qiita コミュニティ・ガイドライン https://help.qiita.com/ja/articles/qiita-community-guideline ※主観 27

28.

文章の書き方 28

29.

構成 ● まずはタイトルとアウトラインから ○ 細かく書き始めると、脱線して仕上がらない ● あとはとにかく書き切る ○ 毎回が本番であり練習 29

30.

個人的に気にしていること ● 文は短く ○ わかりやすく、主語と述語がねじれにくくする ● 流れや接続詞を意識 ○ 各文がきれいでも流れが不自然だと理解しにくい ○ 箇条書きを多用しすぎると感覚が鈍る ● 自分の癖を知っておく ○ 「〜することができる」と書きがち、等 30

31.

個人的なよくある型(チュートリアル系) ● はじめに ○ ○ この記事の書くことにした経緯 何を書くかの説明 ● 準備 ○ 前提となる環境の説明、準備の手順 ● 説明 ○ 手順、結果、解説 ● まとめ ○ この記事の要点、応用への繋ぎ、感想 31

32.

タイトル重要 32

33.

タイトルには どんな役割が ありますか? 33

34.

タイトル重要 ● タイトルは人と記事のインターフェース ○ タイトルで内容が想像できるようにする ○ タイトルと読み手の期待を一致させる ○ 小ネタほどタイトルはシャープになる 34

35.

良いタイトル、良くないタイトル ◎ [Ansible] エラー「paramiko is not installed: No module named 'paramiko'」の原因と対策 ◯ [Ansible] paramiko のエラーについて △ Ansible のエラーについて https://tekunabe.hatenablog.jp/entry/2019/05/19/ansible_paramiko_error ※主観 35

36.

ツール類 36

37.

フォーマット・ツール ● Markdown を覚えておく ○ ブログ以外の GitHub、GitLabなど他サービス、他ツール でも利用できるので、覚えておくと捗る ● 下書きはエディターで保存しながら ○ ブラウザはクラッシュするもの ○ 校正は VS Codeの拡張「テキスト校正くん」が便利 37

38.

考慮事項 38

39.

考慮事項 ● コンプライアンス ○ 著作権、不正競争防止法、契約、組織のソーシャルメディ アポリシーなど ● 正確な情報を心がける 39

40.

コンプライアンス ● ● ● ● ● ● 引用は引用の範囲内にし、引用元を明記する 固有情報は含めずに汎化、マスクする ユーザーが限られるツールの言及は避ける 技術書の内容は丸写しせず、自分のコンテンツに昇華 翻訳も許可を取る ステマしない ブログに技術書の内容を丸写しする問題点と、オリジナルなコンテンツを書くためのアイデア https://blog.jnito.com/entry/2018/01/23/075856 横地が Ansible 公式ブログを翻訳した時の流れ https://twitter.com/akira6592/status/1050037497541971968 40

41.

正確な情報を心がける ● なるべく一次情報を付記する(公式、コード) ● サービスの比較(機能の〇×表など)は注意 ○ 特にクラウドは変化が激しい ● 少なくとも誰かが不利益を被ることは書かないのが無難 ● 不利益がなくても、自信がない場合その旨を付け加える 41

43.

ブログ書くまでが調べ物 あれ調べなきゃ! こっちに追加 ☓ ◎ 43

44.

モチベーションの管理 ● フィードバックはうれしい ○ フィードバックは歩いて来ないので、自分でつかみに行く。 Google Analytics を導入するなど ○ 見てもらうにも工夫が必要 ● モチベーションの源泉を自分に設定 ○ 他者はコントロールできない ○ フィードバックに酔ったり依存すると詰みやすい 44

45.

スキマ時間を使う ● 「まとまった時間」は一生来ない ○ と思ってスキマ時間を利用する ○ ネタやアウトラインだけでもちまち作っておく 45

46.

記事は 何をもって 完成しますか? 46

47.

書ききる ● 記事は諦めたときに完成する ○ こだわり過ぎると仕上がらない 47

49.

まとめ ● ● ● ● ● 自分のために書くのでもいい 今の自分にしか書けないこともある タイトル重要 スキマ時間を使う 書ききる 49

50.

参考 ● ● 資料 ○ ブログを書く技術 ■ https://speakerdeck.com/kakakakakku/blog-is-my-life ○ 技術小ネタのブログを書く時に心がけていること ■ https://note.com/akira6592/n/n33eaa8c700da 書籍 ○ 理科系の作文技術 ■ https://www.chuko.co.jp/shinsho/1981/09/100624.html ○ 数学文章作法 基礎編 ■ https://www.chikumashobo.co.jp/product/9784480095251/ ○ 数学文章作法 推敲編 ■ https://www.chikumashobo.co.jp/product/9784480095251/ 50