現在のフェーズ:
結果の発表。タイムラインをご覧ください。
この例を参考にして、独自のケーススタディ レポートを作成できます。
PicklePlus: GloriousPickle 寄付ツールのドキュメント
組織またはプロジェクト: Glorious Pickle 組織またはプロジェクトのメインサイトへのリンク
組織の説明: GloriousPickle (現在のバージョン 1.2.3、2009 年初リリース) は MIT がライセンスを受けたライブラリで、ピクルスにできるすべての野菜の塩、砂糖、酢、スパイスの完璧な比率を簡単に計算します。
著者: 省略可: 事例紹介の著者を記載します。必要に応じてユーザー名も記入してください
問題の説明/提案の要約
新しいドキュメントやドキュメントを改善して解決しようとしていた問題は何ですか？可能な場合は、プロジェクト サイトの提案ページへのリンク。
GloriousPickle ツールの成分データベースに材料を追加するには、時間がかかり複雑で、ツールには優れたドキュメントがありません。多くのコントリビューターとなる方は、git の使用や pull リクエストの作成の経験がありません。つまり、GloriousPickle には成分データに重大なギャップがあり、ツールの有用性が低下しています。新しい材料を追加するためのドキュメントを改善することで、新しいコントリビューターやより多くのピクルス化が奨励されることを期待しています。
プロジェクトの説明
提案の作成
Google 社員向けドキュメントは、どのように思いついたのですか？アイデアを決定する際、どのようなプロセスを使用していましたか？どのようにフィードバックを募り、取り入れましたか。
GloriousPickle PickleDocs SIG は、Google のオープンソース プログラム オフィスのツイートで、Google Season of Docs プログラムについて知りました。SIG は隔週の会議でプログラムについて話し合い、提案書を作成することに同意しました。SIG の 2 人のメンバー（@KimChiCook と @Dillicious）は、次のミーティングで提案案の下書きを自発的にレビューしました。
PickleDocs SIG が提案書の下書きに同意すると、フィードバックを求めるメールがプロジェクト全体に送信されました。材料追加 API のメンテナンス担当者である @GloriousPicklePat を含む 14 人のコミュニティ メンバーから、フィードバックが寄せられました。@GloriousPicklePat は、プログラム期間中に協力してくれました。
寄せられたフィードバックについて議論し、取り入れた提案は、GloriousPickle プロジェクト運営委員会に送付され、投票が行われました。GPPSC の 5 人のメンバー全員が、提案と申請書の提出に対して +1 に投票しました。@VinegarViv は、プログラムへの参加と支払いの監督に必要な Open Collective アカウントの作成を支援することに同意しました。
予算
予算セクションを短くし、作業量はどのように見積もっていましたか？想定外の支出はありましたか。最終的に、助成金よりも支出が少なくなりましたか？予算は適切に配分されましたか？また、予算を増やした/減らした/不必要に予算を設定した項目もありましたか？Google ドキュメントの Google シーズン以外で、他に使用可能な資金はありましたか。
GloriousPickle PickleDocs SIG のメンバー 2 人は、テクニカル ライターとして働いてきました（ヨーロッパとアルゼンチンで 1 名）。作業量の見積もりや類似のプロジェクト予算の把握を手伝ってくれました。それまでに実施した提案書の下書きを比較していました。また、プロジェクトに割り当てた 2019 年の PicklePals 大会から、無制限のスポンサーシップ資金として 1,000 米ドルが残っていました。
私たちのテクニカル ライターは山火事に巻き込まれた地域に住んでいて、自宅でインターネットにアクセスできないため、不測の出費で Wi-Fi ホットスポットをレンタルできました。参加者に配布する T シャツは予定よりも減ったため、バランスを取ることができました。
さらに、GloriousPickle のコントリビューターである @Piccalily（以前は Piccalily）に報酬を付与し、テクニカル ライターが作成したドキュメントのコピー編集と校正を手伝ってもらうことにしました。
出場選手
このプロジェクトに携わったのは誰ですか（参加者から要求された場合はユーザー名を使用します）どのようにしてテクニカル ライターを見つけて採用しましたか？他のボランティアや有料参加者はどうやって見つけましたか。どのような役割を担っていましたか？途中で離脱した人はいますか？採用、コミュニケーション、プロジェクト管理について、何を学びましたか？
このプロジェクトに携わったコアチームは、
- @Dillicious、@KimChiCook（PickleDocs SIG）
- @Piccalily（copyeditor）
- @GherKen、@VinegarViv（管理者向けヘルプ、GPPSC）
- @BBChips、@GloriousPicklePat（テーマ エキスパート）
- Sam Scribe（テクニカル ライター）
Sam Scribe は Google シーズンの Google ドキュメントに関する GitHub リポジトリのリストで見つけました。Sam の経験（料理雑誌で働いていたり、ウェブサイトのドキュメントを書いていたりした）の経験は、私たちのプロジェクトに適していると考えました。Sam は PickleDocs SIG の隔週ミーティングに参加し、プロジェクトについて話し合い、提案に盛り込まれたいくつかの非常に価値のある提案を行ってくれました。また、SIG メンバーのネットワークを通じて知られているほかの 2 人のテクニカル ライターに連絡しましたが、プログラムの期間中はどちらも対応できませんでした。
Sam のタイムゾーンは PickleDocs SIG のメンバーのほとんどと数時間でしか重複していないため、Sam のタイムゾーンにいて材料の追加プロセスに精通している Pickler のためにディスカッション フォーラムに電話をかけました。@BBChips は、Sam への質問に答え、必要に応じて他の専門家を見つけるのを手伝ってくれました。@GloriousPicklePat も、Sam がツールの基礎となるアーキテクチャと API で発生する可能性のあるエラー メッセージを理解するのを手伝うことに協力してくれ、GitHub と Git のヘルプを提供してくれました。
残念ながら、プログラムの途中で @VinegarViv は個人的な理由でプロジェクトから退出する必要がありました。GPPSC のメンバーの @GherKen が、管理や支払いに関する質問に対応しました。
何度か質問が漏れて（GloriousPickle は無料の Slack インスタンスを使用し、ディスカッションは急激に動き回ることがあり、ローリング アーカイブ制限のために会話が失われてしまうことがあります）、実行している質問のリストを共有ドキュメントに保存する必要があることがわかりました（共有の Google ドキュメントを使用）。PickleDocs SIG のメンバーは、会議の前に毎回確認し、会議の終了前に回答を得るようにしました。Sam は @BBChips に直接 ping して緊急の質問に対応できました。
Sam と Sam との連携にとても満足しています。GloriousPickle のドキュメントを更新したことに加え、Sam も Sam 自体も熱心な Pickler となっています。
タイムライン
プロジェクトのタイムラインの概要を記入します（プロジェクトが進行中の場合は、終了予定日または中間のマイルストーンを記載します）。
Google Season of Docs プログラム参加組織の発表を待っている間に、PickleDocs SIG のメンバーは Sam にとって役立つと思われる過去の課題を検索しました。1 か月かけて、行き詰ったドキュメントを更新するための以前の取り組みからメモを見つけ、Google の opendocs リポジトリにあるドキュメント成熟度監査資料の一部にも目を向けました。
Google シーズン ドキュメントに選ばれたという良いお知らせを受け取ると、Sam と PickleDocs SIG はミーティングを行い、大まかなスケジュールを立てました。
| ステージ | 完了者 |
|---|---|
| ドキュメント監査を確認する | 5 月 7 日 |
| 摩擦ログ 3 のユースケース | 5 月 14 日 |
| @GloriousPicklePat および @BBChips の摩擦ログを確認し、クエリに回答する | 5 月 28 日 |
| 更新版ドキュメント ユースケース 1 の最初のドラフト | 6 月 25 日 |
| ユースケース 1 の下書きを @GloriousPicklePat と @KimChiCook がレビュー | 7 月 2 日 |
| 更新版ドキュメント ユースケース 2 の最初のドラフト | 7 月 2 日 |
| ユースケース 2 のドラフトを @GloriousPicklePat と @Dillicious によってレビュー | 7 月 9 日 |
| 更新版ドキュメント ユースケース 3 の最初のドラフト | 7 月 9 日 |
| ユースケース 3 のドラフトを @Dillicious と @KimChiCook がレビュー | 7 月 16 日 |
| すべてのユースケースであらゆるクエリに対応 | 7 月 30 日 |
| PickleDocs SIG のほとんどが 8 月 1 ～ 20 日に休暇にいた | -- |
| コミュニティで新しいドキュメントのテストを開始（GloriousPickle のサイトでドラフトとして公開されたドキュメント） | 8 月 21 日 |
| テストのフィードバックを組み込む | 9 月 10 日 |
| 新しいドキュメントのコピー編集と校正 | 9 月 17 日 |
| ドキュメントの下書きのステータスを削除、ドキュメントを正式にリリース | 9 月 28 日 |
| 作成されたドキュメントを更新するプロセス | 11 月 1 日 |
| このケーススタディを作成しました | 11 月 8 日 |
| 事例紹介の提出 | 11 月 16 日 |
提案予算では、テクニカル ライターが週に 10 ～ 15 時間をプロジェクトの作業に費やすことと推定していました。作業時間の記録は、週平均 11.5 時間です。
結果
作成、更新、または変更された点は何ですか？公開ドキュメントがある場合は、そのリンクを記載します。提案に含まれていなかった成果物は作成されませんでしたか。それらも記入してください。
3 つの主要なユースケースと、詳細なユーザー入門ガイドを文書化しました。
GloriousPickle に新しい材料を追加する方法
GloriousPickle にバリエーションの材料を追加する方法
GloriousPickle の材料を更新または修正する方法
また、これらのガイドには、投稿を容易にする新しい pull リクエスト テンプレートも含まれています。
さらに、プロジェクト中に、学習した用語を集めた小さな Pickle Glossary も作成し、GloriousPickle プロジェクト サイトでも公開しました。
これらのユーザー入門ガイドを更新する手順をプロジェクト Wiki に追加しました。
GitHub を初めて使用するコントリビューターがプロセスとツールを使用するのに役立つクイック リファレンスを作成する必要がありましたが、利用可能なリソースを確認したところ、代わりに別のプロジェクトのクイック リファレンスをフォークできました。
指標
プロジェクトの成功を測定するため、どのような指標を選択しましたか。それらの指標を収集できましたか？指標は、プロジェクトに期待する成果とうまく相関していましたか、それとも悪かったですか。提案の後、指標に変化はありましたか？
この提案では、次の 2 つの指標を提案しました。
- 食材関連の pull リクエストの数
- 新しいコントリビューターからの pull リクエストの数
9 月（ドラフト ドキュメント公開後の最初の丸 1 か月）には、材料関連の pull リクエストが 5% 増加し（8 月は 20 件から 9 月は 21 件に）、合計 4 件の pull リクエストがありました（8 月に 2 件の新しい投稿者が pull リクエストを 2 回行ったのに対して）。これらの指標は毎月追跡する予定です。
1 月 1 日以降は、ドキュメントの公開後四半期ごとに、合計で 3 回以上の貢献をしたコントリビューターの数も追跡します。
最近では、この新しいドキュメントが、新しいコントリビューターが GloriousPickle の成分データベースに追加できる状況に違いをもたらしたと考えられます。ある PR のコメントで、ある新しいコントリビューターが、以前に試したことはあるもののプロセスを理解していなかったために更新を完了できなかったと言及しました。
分析
うまくいった点何が予想外だったのでしょうか。どのような困難や困難に直面しましたか？プロジェクトは成功したと思いますか？その理由をお聞かせください。（判断するのが早すぎる場合は、プロジェクトの成功を判断できる時期を説明してください）。
Google シーズンの Google ドキュメント プロジェクトの結果に大変満足しており、成功しました。新しいドキュメントは明確で有用です。材料に関連する pull リクエストの件数と、新しいコントリビューターからの pull リクエストの件数はすでにある程度増加しています。
また、GloriousPickle コミュニティのほぼ全員が参加し、元の提案に対してフィードバックを提供したり、新しいドキュメントをドラフト形式でテストしたりできたことも嬉しく思っています。
私たちは予期せぬ困難に直面しました。サム州で起きた山火事は、インターネットの停止ほどの被害をもたらしなかったことに感謝しています。また、プロジェクトから @VinegarViv を失い、残念に思います。彼らとその家族の安全を願い、また彼女に会えることを願っています。
Sam がドキュメントの作成を開始するまで、Google は、Pickle 関連の用語や頭字語がいかに多いかというものでした。これは、Pickle の知識がない人にとっては、なじみが薄いというものでした。しかし、Sam さんは、馴染みのない用語をすべてリストアップしておき、独自の調査やコミュニティ メンバーに説明や参考情報を求めることでそれらの用語を定義しました。この Pickle 用語集は、今後より多くの人々をピクルス コミュニティに迎えるうえで大いに役立ちます。
概要
プロジェクトの経験を 2 ～ 4 段落にまとめています。学んだことと、今後別の方法を取ろうとしていることを強調します。ドキュメントを使って同様の問題を解決しようとしている他のプロジェクトに対して、どのようなアドバイスをしますか。
一言で言えば、私たちの体験はピクルスでした。ドキュメントの成果物は達成し、指標は目標に沿っているようです。
このプロジェクトの成功の大きな要因は、テクニカル ライターである Sam Scribe と共同作業を行えたことがとても幸運だったことです。[私は書いたことはありません—Sam] Sam は GitHub のピクリングや経験は持っていませんが、経験豊富なテクニカル ライターでありながら、新しいテーマ分野に飛び込み、質問を投げかけ、調査を行うことには抵抗がありません。Sam はすぐにプロジェクト ツール（かんばんを使って作業を追跡している）だけでなく、おなじみのジョークもすぐに聞き取ってくれました。Sam がピクルスのバグを捕まえ、コミュニティに「瓶詰め」させてあげたことをとてもうれしく思います。
他のプロジェクトでは、次のことをおすすめします。
- 提案は小さくて扱いやすいものにします。（当初は、工業用バッチピクルス機械での推定ツールを使用するためのドキュメントを含める必要がありましたが、オープンソース化のピクルス機械に深く関与しているコミュニティ メンバーの 1 人がプログラム中に博士論文を書く予定だったため、省略しました）。最終的に、サムを飽きさせないほどの仕事ができました。
- テクニカル ライターを探す際はネットワークを活用しましょう。コミュニティの全員におすすめを尋ねましょう。田中さんとは、Google ドキュメント GitHub の Google シーズンで知りましたが、応募期間中に何人かの人に話を聞くことができたため、自信を持って彼らと連携できました。
- テクニカル ライターをコミュニティに迎え入れます。また、GloriousPicklers の熱烈な姿勢のおかげで簡単に質問できるようになりました。
- テクニカル ライターがオープンソースのスキルを取得できるよう支援します。サムはこれまで git を使ったことがありませんでしたが、チュートリアルをいくつか受けたところ、すぐに使いこなせるようになりました。当初、Sam はコミュニティからどれだけのフィードバックが得られるか、どのようにフィードバックを取り入れるかに懸念していましたが、コミュニティの「大まかなコンセンサス」モデル（「すべての問題に対処したが、必ずしも対応していないときにコンセンサスが成り立つ」）ため、サムはテクニカル ライティングの専門知識を駆使して批判に対処することに自信を持てました。
付録
リンクしたい資料が他にある場合は（テクニカル ライターとの作業に関する契約書を共有したい場合、ドキュメント プロジェクトのテンプレート、その他の公開ドキュメント リソースなど）をここでリストしてリンクできます。また、付録には、使用したドキュメント ツールやリソースへのリンクを記載したり、上記のセクションに当てはまらない可能性がある感謝や謝辞を書き込んだりすることもできます。
謝辞
下記のメンバーおよびご本人に感謝いたします。
- @Dillicious はパートナーに感謝し、ローファイ ヒップホップ ラジオにも感謝します
- @KimChiCook は、お好み焼きの方法を教えてくれる 할머인 に感謝します
- @Piccalily は Chicago Manual of Style Online に感謝の意を表します。
- @GherKen は、作れるピクルスをすべて食べてくれた 3 人の子どもたちに感謝します
- @VinegarViv は、退職にあたりチームの他のメンバーに感謝の意を表します。
- @BBChips は、最高のピクルスでない食べ物である Tunnock's Caramel Wafers に感謝しています。
- @GloriousPicklePat は、このプロジェクトにご協力いただいた PickleDocs SIG に感謝します。
- Sam Scribe は GloriousPickle のコミュニティ全体に感謝の気持ちを伝えていますが、特に 2021 年夏の瓶不足で缶詰の瓶を送ってくれた Picklers にたくさんのおいしいピクルスを提供する道をスタートさせました。