チームで定期的にブログを書けるようにした / Tips for writing regular technical blog posts with your team

2023年3月24日の NTT Tech Conference で発表した「チームで定期的にブログを書けるようにした」の発表資料です。
詳細：https://ntt-developers.github.io/ntt-tech-conference/2023/ （Track2, Lighting Talks）

Transcript

1. © NTT Communications Corporation All Rights Reserved.
   チームで定期的にブログを書けるようにした
   2023.03.24
   NTTコミュニケーションズ株式会社 イノベーションセンター
   岩田 紘成
   1
   

   View Slide

2. © NTT Communications Corporation All Rights Reserved. 2
   自己紹介

   岩田 紘成（@shirobrak）
   ● 趣味：登山、キャンプ、散歩、白バラコーヒー
   ● 2018年入社（5年目）
   ● 役割
   ○ ソフトウェアエンジニア
   ○ スクラムマスター
   ● 業務
   ○ NTT レゾナント株式会社（~2021.03）
   ■ メディアサービス開発
   ■ オンラインワークスペースサービス開発
   ● NTT コミュニケーションズ株式会社（2021.04~）
   ○ ネットワーク技術のR&D
   ○ スタートアップ（SpoLive）の開発支援
   2
   

   View Slide

3. © NTT Communications Corporation All Rights Reserved.
   開発者ブログで
   ネットワーク技術の検証成果を連載形式で公開しました
   ● 内容
   ○ 2021 年度に取り組んだ成果サマリを 2022 年度に公開した
   ● モチベ
   ○ やった事は発信していこうというチーム方針
   ○ 扱っている内容がニッチなので、積極的に発信して繋がっていかないと
   チーム外から情報が得られない
   ○ etc…
   ● 公開して良かったこと・感じたこと
   ○ オンサイトであった人や SNS 上で「読んでるよ」と反応を貰えてうれしかった
   ○ 会社としてアウトプットするプラットフォームを運用してもらっているのはとても助かる
   ○ etc…
   3
   今日は 5 分しかないので
   記事を隔週で届けるために取り組んだ課題と工夫
   についてしゃべります
   

   View Slide

4. © NTT Communications Corporation All Rights Reserved.
   考えたこと その１
   どうやって技術記事としての品質を保つか？
   4
   記事の品質として気を付けたポイント
   ✓ 誰が執筆しても情報の抜け漏れがない記事にする
   ✓ 技術用語を正しく使う（間違った情報を載せない）
   ✓ 連載記事の間で技術や文章表現に一貫性を持たせる
   これらを満たした記事を書くには
   いつ・何を確認すればいいだろう？🤔
   記事を書く体制
   連載記事１１本 を 5人で分担して執筆
   

   View Slide

5. © NTT Communications Corporation All Rights Reserved.
   考えたこと その１
   どうやって技術記事としての品質を保つか？
   執筆前に骨子を作成し、何を書くべきか？の認識を合わせるようにした
   5
   概要章
   記事で扱うネットワーク技術を説明す
   る
   検証章
   概要章で説明した技術を使うための
   ルーターのコンフィグと動作確認方法を
   説明する
   ● 最低限説明が必要な要素は何か？
   ○ 節タイトルまでは決めておく
   ● どんなネットワーク構成で、どんな検証をするのか？
   ○ 確認コマンドとかも分かれば載せておく
   骨子の構成
   おわりに
   タイトル
   サマリ
   ● 今回新しく出てきた技術用語の表記をどうするか？
   

   View Slide

6. © NTT Communications Corporation All Rights Reserved.
   考えたこと その１
   どうやって技術記事としての品質を保つか？
   技術用語の表記や日本語表現の統一する仕組みを導入した
   ○ 技術用語の正しさ：チームで作成したワードチェッカー
   ○ 日本語としての正しさ：ブログ運用チームが用意してくれてるツール
   6
   技術用語チェッカー（一部） GitHub PR のテンプレートにチェック項目を盛り込む
   

   View Slide

7. © NTT Communications Corporation All Rights Reserved.
   考えたこと その２
   どうやって効率的に記事を生み出すか？
   7
   骨子作成
   チーム
   レビュー
   ブログ運営チーム
   レビュー
   公開！！🎉
   １～２日 １～２日
   公開までの執筆フロー（連載開始時）
   記事執筆
   RFC/I-D 再読、再検証、etc…
   ３～５日
   全部で11本（半年弱）もあるし、
   落とさないための執筆フローを考えた方が良くない？🤔
   隔週での連載開始後に
   記事１本に意外と時間がかかることが判明
   

   View Slide

8. © NTT Communications Corporation All Rights Reserved.
   考えたこと その２
   どうやって効率的に記事を生み出すか？
   ● 重い記事執筆タスクを分割
   ● 骨子を「ある程度」詳細にしておくと複数人で執筆しても問題なかった
   骨子作成
   検証例章の
   再検証環境の構築
   チーム
   レビュー
   ブログ運営チーム
   レビュー
   公開！！🎉
   １～２日 １～２日
   公開までの執筆フロー（連載終了時）
   検証例章の執筆
   ０.５ ～１日
   概要章の執筆
   ２～３日
   ０.５ ～１日
   8
   

   View Slide

9. © NTT Communications Corporation All Rights Reserved.
   まとめ
   いろいろ工夫して隔週での検証成果の記事デプロイに成功しました！
   9
   👇 連載を何とか乗り切った様子
   

   View Slide

10. © NTT Communications Corporation All Rights Reserved. 10
    今回公開した記事に興味もって頂けた方は
    👇 で検索お願いします
    

    View Slide