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