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

Slide 1

Slide 1 text

Slide 2

Slide 2 text

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

Slide 3

Slide 3 text

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

Slide 4

Slide 4 text

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

Slide 5

Slide 5 text

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

Slide 6

Slide 6 text

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

Slide 7

Slide 7 text

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

Slide 8

Slide 8 text

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