Upgrade to Pro — share decks privately, control downloads, hide ads and more …

OSSのメンテナが 入門ハンズオンを なぜ・どのように作成したか

OSSのメンテナが 入門ハンズオンを なぜ・どのように作成したか

2024-09-14 DevRel/Japan CONFERENCE 2024での登壇資料です。
https://devrel.tokyo/japan-2024/sessions/e87fbaa0-dff1-4bfb-b29f-6faf618abf56/

※SpeakerDeck用に、フォントを一部調整しています。

Tetsuya Kikuchi

September 14, 2024
Tweet

More Decks by Tetsuya Kikuchi

Other Decks in Marketing & SEO

Transcript

  1. #DevRelJP Software Engineer ◦ 所属: (株)サイバーエージェント ◦ PipeCDのメンテナ ▪ 開発(主にAWS関連)

    ▪ 社内サポート ▪ 普及活動 菊池 哲哉 Kikuchi Tetsuya @t-kikuc @t_kikuc 2
  2. #DevRelJP PipeCD入門ハンズオンとは • PipeCDの構築からデプロイまでを試せる ◦ 公開: 2024年5月 ◦ 言語: 英語・日本語

    ◦ 所要時間: 30分~1時間ほど https://github.com/pipe-cd/tutorial/blob/main/content/ja/README.md 7
  3. #DevRelJP 2. 他の施策より重要だった • 他にもやりたいことは多数 ◦ メディア、イベント露出を増やす ◦ 他ツールからの移行を容易に ◦

    本番構築コストを下げる ◦ コントリビューションを簡単に ◦ 情報量(プラクティス等)の拡充     ・・・ 14
  4. #DevRelJP 2. 他の施策より重要だった • 他にもやりたいことは多数 ◦ メディア、イベント露出を増やす ◦ 他ツールからの移行を容易に ◦

    本番構築コストを下げる ◦ コントリビューションを簡単に ◦ 情報量(プラクティス等)の拡充     ・・・ 15 ユーザ数 情報量 開発者数
  5. #DevRelJP 作成の流れ 1. 参考資料にあたる 2. 前提知識とゴールの設定 [最重要] 3. 執筆 4.

    動作検証 5. 英語版公開 +α 日本語版作成・公開 23 約1ヶ月
  6. #DevRelJP 2/5. 前提知識とゴールの設定 • なぜ必要か? ◦ 読者が Not for me

    かをすぐに判断できる ◦ 説明の取捨選択の判断基準になる ▪ 読者: 情報過不足はストレス ▪ 筆者: 書くか書かないか迷うのは無駄 26
  7. #DevRelJP 2/5. 前提知識とゴールの設定 • ゴールの設定 「PipeCDを触ったことある人」とは?   27 ✅ゴールとすること •

    簡易的に構築する • 最低限の機能を動かす • 最低限の仕組みを理解する ☑ゴールとしないこと • 本番向けの構築 • 様々な機能を使う • 網羅的な理解 • PipeCD自体の開発
  8. #DevRelJP 2/5. 前提知識とゴールの設定 • 前提知識の設定 「PipeCD/入門ハンズオンに興味を持つ人」とは?   28 ✅前提とする知識 •

    PipeCDとは何か • Git,CI/CDの基礎 • K8s/CloudRun/Terraform/ ECS/Lambdaのいずれか ☑前提としない知識 • PipeCDの各種用語 • PipeCDの仕組み
  9. #DevRelJP 3/5. 執筆 つまずき=離脱を防ぐ • 手間を減らす: 前提条件、作業ステップ数 • 説明を減らす: 前提知識・ゴールに基づいて取捨選択

    ◦ 図も入門者向けに新作 • 「知識の呪い」に注意 ◦ 知識の呪い: 「自分が知っていることは 相手も知っている」と誤認すること ◦ 対処法: 入門者にヒアリング 29
  10. #DevRelJP +α. 日本語版も作成・公開 • メンテコストを観察してから実行した ◦ 5月末 英語版公開 → 8月上旬

    日本語版公開 • 翻訳作業は1日で完結 ◦ そもそもボリュームを減らしていた ◦ 画像とCodeは日英で共通 32
  11. #DevRelJP 結果 • 定量面(GitHub Insights) ◦ unique visitor: のべ350人ほど ◦

    unique cloner: のべ70人ほど ▪ ≒ハンズオンをやってみた人数 ◦ 英語版/日本語版公開日やイベント参加日に増加 • 定性面 ◦ 「入門で挫折」を恐れずに認知拡大へ 34
  12. #DevRelJP 参考・関連資料 • PipeCD公式サイト https://pipecd.dev/ • (PipeCDの沿革) Our Journey from

    In-House CD System to Open Source https://speakerdeck.com/ffjlabo/our-journey-from-in-house-cd-system-to-open-source • The AAARRRP Developer Relations Strategy Framework https://www.leggetter.co.uk/aaarrrp/ • Kubernetes Tutorial https://kubernetes.io/ja/docs/tutorials/ • 『エンジニアのためのドキュメントライティング』 https://amzn.asia/d/8QigkRD • 『DevRelの教科書』 https://amzn.asia/d/dkqVmkL 38