現在のフェーズ:
結果が発表されました。タイムラインをご覧ください。
この例を参考に、独自のケーススタディ レポートを作成してください。
PicklePlus: GloriousPickle の貢献ツールのドキュメント
組織またはプロジェクト: Glorious Pickle 組織またはプロジェクトのメインサイトへのリンク
組織の説明: GloriousPickle（現在のバージョン 1.2.3、2009 年に初リリース）は、MIT ライセンスのライブラリで、あらゆる漬物に適した塩、砂糖、酢、スパイスの比率を簡単に計算できます。漬物にできる野菜の量は、1 つの小さなキュウリからコンテナ船に積まれた大根までさまざまです。
作成者: 省略可: ケーススタディの作成者をリストします。リクエストされた場合はユーザー名を使用します
問題の説明/提案の概要
新しいドキュメントや改善されたドキュメントで解決しようとしていた問題は何ですか？可能であれば、プロジェクト サイトの提案ページへのリンクを記載してください。
GloriousPickle ツールの原料データベースに材料を追加する作業には時間がかかり、複雑で、ツールのドキュメントも整備されていません。コントリビューターになりたい人の多くは、git の使用や pull リクエストの作成の経験がありません。これは、GloriousPickle の原材料データに深刻なギャップがあり、ツールの有用性を低下させていることを意味します。新しい食材を追加するためのドキュメントを改善することで、新しいコントリビューターが参加しやすくなり、より多くのピクルスが作られることを願っています。
プロジェクトの説明
提案書の作成
Google Season of Docs の提案はどのようにして思いつきましたか？組織でアイデアを決定するために使用したプロセスは何ですか。フィードバックをどのように募集し、取り入れましたか？
GloriousPickle PickleDocs SIG は、Google のオープンソース プログラム オフィスのツイートを通じて Google Season of Docs プログラムを知りました。SIG は隔週の会議でプログラムについて話し合い、提案書を作成することに同意しました。SIG の 2 人のメンバー（@KimChiCook と @Dillicious）が提案書の草案に取り組み、次回のミーティングでレビューしました。
PickleDocs SIG が提案書の下書きに同意すると、プロジェクト全体にフィードバックを依頼するメールが送信されました。14 人のコミュニティ メンバーからフィードバックが寄せられました。その中には、材料追加 API のメンテナーである @GloriousPicklePat も含まれています。@GloriousPicklePat は、プログラム中のリソースとしてボランティアに参加しました。
受け取ったフィードバックを議論して取り入れ、提案は GloriousPickle プロジェクト ステアリング コミッティに送信され、投票されました。GPPSC の 5 人のメンバー全員が、提案書と申請書の提出に賛成票を投じました。また、@VinegarViv は、プログラムへの参加と支払いの管理に必要な Open Collective アカウントの作成を支援することに同意しました。
予算
予算に関する短いセクションを追加します。作業時間をどのように見積もりましたか？予期しない費用はありましたか？結局、資金は助成金よりも少なくなりましたか？資金は適切に割り当てられましたか？予算を組んだ項目の一部は、多すぎたり少なすぎたり、不要だったりしましたか？Google ドキュメントのシーズン以外で使える資金はありましたか。
GloriousPickle PickleDocs SIG のメンバーのうち 2 人はテクニカル ライターとして働いています（1 人はヨーロッパ、もう 1 人はアルゼンチン）。以前に作成した提案書の下書きと比較して、作業量を見積もったり、類似のプロジェクトの予算を調べたりしました。また、2019 年の PicklePals コンベンションから残った、制限なしのスポンサーシップ資金 1,000 米ドルもプロジェクトに充てられました。
予期せぬ費用として、山火事の影響を受けた地域に住むテクニカル ライターが自宅でインターネットにアクセスできなくなったため、Wi-Fi アクセス ポイントをレンタルしたことが挙げられます。また、参加者に送る T シャツの数が当初の計画より少なかったので、バランスが取れました。
また、技術ライターが作成したドキュメントのコピー編集と校正を支援するため、GloriousPickle の投稿者である @Piccalily（かつてピクルス以外の生活でプロのコピーエディタだった）に報酬を支払うことにしました。
参加者
このプロジェクトに携わったメンバー（参加者がリクエストした場合はユーザー名を使用）技術ライターをどのように見つけ、採用しましたか？他のボランティアや有料参加者をどのように見つけましたか？どのような役割を担っていましたか？誰かが脱落しましたか？採用、コミュニケーション、プロジェクト管理について学んだことは何ですか？
このプロジェクトに携わったコアチームは次のとおりです。
- @Dillicious、@KimChiCook（PickleDocs SIG）
- @Piccalily（校正編集者）
- @GherKen、@VinegarViv（管理者向けヘルプ、GPPSC）
- @BBChips、@GloriousPicklePat（内容領域の専門家）
- Sam Scribe（テクニカル ライター）
Sam Scribe は Google Season of Docs GitHub リポジトリ リストから見つけました。彼らの経験（Sam は料理雑誌で働いていたし、ウェブサイトのドキュメントを執筆していたことも）は、私たちのプロジェクトによくマッチするものだと思いました。Sam は PickleDocs SIG の 2 週間に 1 回のミーティングに参加し、プロジェクトについて話し合いました。その際、いくつかの非常に有益な提案があり、提案書に組み入れました。また、SIG メンバーのネットワークを通じて知っている他の 2 人のテクニカル ライターとも連絡を取りましたが、いずれもプログラムの期間中は連絡が取れませんでした。
Sam のタイムゾーンは PickleDocs SIG のほとんどのメンバーと数時間しか重複しないため、Google は、Sam のタイムゾーンにいて、材料の追加プロセスに精通している Pickler を、Google のディスカッション フォーラムで募集しました。@BBChips は、Sam の質問に回答し、必要に応じて他のエキスパートを探す手助けをすることを申し出ました。@GloriousPicklePat は、ツールの基盤となるアーキテクチャと API から返される可能性のあるエラー メッセージについて Sam をサポートし、GitHub と git のサポートも提供しました。
残念ながら、番組の途中で @VinegarViv さんが個人的な理由によりプロジェクトから離れざるを得なくなりました。GPPSC のメンバーである @GherKen が、管理や支払いに関する質問に対応できるようにしました。
質問に答えられないことがあったので（GloriousPickle は無料の Slack インスタンスを使用しており、会話が急速に進み、アーカイブのロールオーバーの上限に達して会話が失われることがある）、進行中の質問のリストを共有ドキュメント（共有 Google ドキュメントを使用）に保存する必要があることがわかりました。PickleDocs SIG メンバーは、ミーティングの前にこれを確認し、ミーティングの終了前に回答を得るようにした。Sam は緊急の質問を @BBChips に直接送信できました。
Sam と協力できたことは非常に幸運でした。Sam は GloriousPickle のドキュメントを更新しただけでなく、熱心なピクルス メーカーにもなりました。
タイムライン
プロジェクトのタイムラインの概要を簡単に説明します（プロジェクトが進行中の場合は、終了予定日または中間マイルストーンを指定します）。
Google Season of Docs プログラムの参加組織が発表されるのを待っている間、PickleDocs SIG のメンバーは、Sam に役立つと思われる過去の作業を検索しました。1 か月間かけて、ドキュメントの更新作業が中断された以前の取り組みに関するメモを見つけ、Google OpenDocs リポジトリのドキュメントの成熟度監査資料の一部にも取り組みました。
Google Season of Docs に選ばれたという良い知らせを受けて、Sam と PickleDocs SIG はミーティングを行い、大まかなスケジュールを立てました。
| ステージ | 完了者 |
|---|---|
| ドキュメントの監査を確認する | 5 月 7 日 |
| 摩擦ログ 3 のユースケース | 5 月 14 日 |
| @GloriousPicklePat と @BBChips と一緒に摩擦ログを確認し、質問に回答する | 5 月 28 日 |
| 更新済みドキュメント ユースケース 1 の第 1 ドラフト | 6 月 25 日 |
| ユースケース 1 の下書きを @GloriousPicklePat と @KimChiCook が確認しました | 7 月 2 日 |
| 更新済みドキュメント ユースケース 2 の第 1 ドラフト | 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 で材料を更新または修正する方法
また、これらのガイドには、貢献を容易にするための新しいプルリクエスト テンプレートも含まれています。
また、プロジェクト期間中に、学んだ用語の簡単な Pickle 用語集を作成しました。この用語集は GloriousPickle プロジェクト サイトにも公開されています。
これらのユーザー向けハウツー ガイドを更新するための手順をプロジェクトのウィキに追加しました。
GitHub を初めて使用するコントリビューター向けに、プロセスとツールの使用を支援するチェックシートの作成を予定していましたが、利用可能なリソースを確認した結果、別のプロジェクトのチェックシートをフォークすることにしました。
指標
プロジェクトの成功を測定するために、どのような指標を選択しましたか？これらの指標を収集できましたか？指標は、プロジェクトに期待される成果との相関関係を示していますか？提案時から指標に変化はありましたか？
提案では、次の 2 つの指標を提案しました。
- 成分関連の pull リクエストの数
- 新しいコントリビューターからの pull リクエストの数
9 月（ドラフト ドキュメントの公開から最初の 1 か月間）は、成分関連のプルリクエストが 5% 増加しました（8 月の 20 件から 9 月の 21 件）。また、3 人の新規コントリビューターが合計 4 件のプルリクエストを送信しました（8 月の 2 人の新規コントリビューターが送信した 2 件のプルリクエストと比較して）。これらの指標は毎月追跡される予定です。
1 月 1 日より、ドキュメントの公開後 3 か月ごとに、全体で 3 回以上貢献したコントリビューターの数も追跡します。
新しいドキュメントにより、新しいコントリビューターが GloriousPickle の成分データベースに追加できるようになったという報告が寄せられています。ある新しいコントリビューターは、以前に試したことがあったものの、プロセスを理解していなかったため更新を完了できなかったと PR のコメントで述べています。
分析
上手くいった点想定外だった点はどのような点ですか？どのような障害や挫折に直面しましたか？プロジェクトは成功したと思いますか？その理由をお聞かせください。（判断するには時期尚早の場合は、プロジェクトの成功を判断できる時期を説明してください）。
Google Season of Docs プロジェクトの結果に非常に満足しており、成功と考えています。新しいドキュメントは明確で有用であり、すでに、コンポーネント関連のプルリクエスト数と、新しいコントリビューターからのプルリクエスト数の増加が見られます。
また、元の提案に関するフィードバックを提供したり、新しいドキュメントをドラフト形式でテストしたりして、GloriousPickle コミュニティのほぼ全員が参加できたことに満足しています。
予想外の障害がいくつかありましたが、サムさんが住む州の山火事でインターネットが停止した以外に被害がなかったことを心から感謝しています。また、@VinegarViv さんがプロジェクトから離脱されたことを残念に思います。彼女とそのご家族に幸多かれとお祈り申し上げます。また、彼女が YouTube に戻ってくることを心より願っております。
Sam がドキュメントの作成を開始するまで、私たちが気づかなかったことの 1 つは、pickle に関する経験のない人にはなじみのない pickle 関連の用語や頭字語がいかに多いかということでした。ただし、Sam は、不明な用語をすべてリストにまとめ、独自の調査やコミュニティ メンバーに説明や参考資料を求めて、それらを定義しました。このピクルス用語集は、今後、より多くの人々をピクルス コミュニティに迎え入れる際に大いに役立つでしょう。
概要
プロジェクトの経験を 2 ～ 4 つの段落で要約してください。学んだこと、今後どのように変えたいかを強調します。ドキュメントに関する同様の問題を解決しようとしている他のプロジェクトに、どのようなアドバイスを送りますか？
一言で言えば、ピクルス エクスペリエンスは最高でした。ドキュメントの成果物は完成し、指標は目標に沿っているようです。
このプロジェクトの成功の大きな要因は、技術ライターの Sam Scribe と協力できたことです。[これは私が書いたものではありません - Sam] Sam はピクルスに関するバックグラウンドや GitHub の経験はありませんでしたが、経験豊富な技術ライターとして、新しい分野に飛び込んで質問したり、調査したりすることに抵抗はありませんでした。Sam はすぐに、プロジェクト ツール（作業状況を記録するためにかんばんを使っています）だけでなく、ピクルス ジョークも紹介してくれました。Sam がピクルスの虫をつかまえて、コミュニティで「ボトリング」できたことにとても満足しています。
他のプロジェクトでは、以下を行うことをおすすめします。
- 提案書は小さく、管理しやすいものにします。（当初は、産業用バッチ漬け込み機械で推定ツールを使用するドキュメントを提案書に含める予定でしたが、漬け込み機械のオープンソース化に深く関わっているコミュニティ メンバーの 1 人がプログラム中に博士論文を執筆する予定だったため、除外しました）。結果的に、サムさんが十分に忙しくできるだけの仕事が見つかりました。
- 技術ライターを探す際には、ネットワークを活用しましょう。コミュニティ内の全員におすすめを尋ねます。Sam は Google Season of Docs GitHub で見つけましたが、応募期間中に複数の人と話したため、一緒に仕事をすることに自信がありました。
- 技術ライターをコミュニティに迎え入れましょう。Sam は、GloriousPicklers の熱心な姿勢のおかげで、質問しやすかったと語っています。
- 技術ライターがオープンソースのスキルを習得できるようサポートします。サムは Git を初めて使用しましたが、いくつかのチュートリアルを試した後、すぐに使いこなせるようになりました。最初、サムはコミュニティからどれくらいのフィードバックが得られるか、そのフィードバックをどのように取り入れたらよいか心配していましたが、Google のコミュニティの「大まかなコンセンサス」モデル（「コンセンサスはすべての問題に対処したときに達成されるが、必ずしも対応する必要はない」）により、サムは技術的な文章作成の専門知識を使って批判に対処することに自信を持つことができました。
付録
リンク先として他の資料がある場合（たとえば、共有する技術ライターとの契約書、ドキュメント プロジェクトのテンプレート、その他の公開ドキュメント リソースを作成した場合は、ここでリストしてリンクできます）。付録には、使用したドキュメント ツールやリソースへのリンクを記載したり、上記のセクションに収まらない謝辞や謝意を記載したりするのにも適しています。
謝辞
つきましては、以下のメンバーと事項についてお礼を申し上げます。
- @Dillicious はパートナーと ローファイ ヒップホップ ラジオに感謝しています
- @KimChiCook は、漬け物の作り方を教えてくれた 할머니 に感謝しています
- @Piccalily は Chicago Manual of Style Online に感謝しています
- @GherKen は、作ったピクルルをすべて食べてくれた 3 人の子供に感謝しています
- @VinegarViv は、退任に際してチームの皆様にご協力いただいたことに感謝しています
- @BBChips は、ピクルス以外の最高の食べ物である Tunnock's Caramel Wafers に感謝しています
- @GloriousPicklePat は、このプロジェクトに取り組んだ PickleDocs SIG に感謝の意を表します。
- Sam Scribe は、GloriousPickle コミュニティ全体に感謝の意を表します。特に、2021 年夏の瓶不足の際に、おいしいピクルスの道を歩み始めた Sam に、密閉瓶を送ってくれた Pickler の皆様に感謝します。