現在のフェーズ:
結果が発表されましたタイムライン。
このガイドをテンプレートとして使用し、組織のプロジェクト提案書を作成してください。
提案タイトル - 組織名
提案のタイトルは簡潔で具体的なものにする必要があります。提案のタイトルとして「ORGNAME コントリビューター ガイドを更新」とすることをおすすめします。「ドキュメントの改善」があいまいすぎる。「コントリビューター ガイドのセクション 5、7、23、99 の更新、よくある質問の作成、スタイルガイドの作成」は長すぎる。
組織について
このセクションでは、組織またはプロジェクトについて数段落で簡単に説明してください。プロジェクトが解決する問題は何ですか?ユーザーとコントリビューターは誰か。組織またはプロジェクトの設立からどのくらい経ちますか。お客様の提案に資金提供することで、オープンソースや世界に好影響を与える理由を理解できるよう、状況を少しご説明ください。
GloriousPickle(現在のバージョン 1.2.3、2009 年初リリース)は、MIT がライセンスを受けたライブラリで、ピクルスとなる可能性のあるすべての野菜の塩、砂糖、酢、スパイスの完璧な比率を簡単に計算します。投稿者は世界中のピクルス愛好家で、ユーザーはホームシェフ、レストラン シェフ、大規模な食品加工企業や組織の物流に従事する人たちです。私たちの最大のユーザーは、フードバンクが賞味期限が短い野菜を安定したピクルスの瓶に変え、多くのコミュニティで空腹の人々に食べさせるのを支援し、食品廃棄物の削減に貢献する組織です。さらに、ユーザーから GloriousPickle の使用に関するオプションの指標が送信され、Google はこれを使用して PickleSet を生成します。このデータセットは、ML を通じて新しいピクルスのレシピを作成するための大規模なデータセットです。
プロジェクトについて
プロジェクトの問題点
お客様のプロジェクトが解決に役立つ問題についてお知らせください。この問題を解決することが組織またはプロジェクトにとって重要なのはなぜですか。
ユーザーは、新しいスパイスやその他の食材(特に欧州以外の料理の食材)に関する情報を GloriousPickle ツールに追加したいと考えています。残念ながら、この情報を追加するプロセスが十分に文書化されていません。つまり、潜在的な投稿者は、支援を受けるにはプロジェクトのイシューをオープンしなければなりません(または、完全に諦めることになります)。また、このプロセスでは、コントリビューターがすでに Google の pull リクエスト プロセスと GitHub に精通していることを前提としていますが、ユーザーの多くがプロのデベロッパーではありません。
食材に関する情報が多いほど、GloriousPickle はすべてのユーザーに役立ちます。
プロジェクトの範囲
組織で作成、更新、または改善されるドキュメントについてお聞かせください。一部の作業が意図的に行われていない場合は、その情報も含めます。また、推定所要時間と、プロジェクトに取り組む組織のボランティアとテクニカル ライターが特定済みかどうかを記載します。
GloriousPickle プロジェクト(コードネーム PicklePlus)は、次のことを行います。
- 既存のドキュメントを監査し、3 つの主要なユースケース(新しい材料の追加、異なる材料の追加、材料に関する情報の更新または修正)について、現在のドキュメントの摩擦ログを作成します。
- 摩擦ログをドキュメント内のギャップを理解するためのガイドとして使用し、主なユースケースのドキュメントの更新版を作成します。
- pull リクエストを初めて行うコントリビューターがプロセスを使用できるように、簡単な「クイック リファレンス」と GitHub を作成してください。
- ドキュメントのテスター(プロジェクトのボランティア)やより広範な GloriousPickle コミュニティからのフィードバックを取り入れます。
- リリースチームと協力して GloriousPickle サイトのドキュメントを更新し、今後もドキュメントと更新ツールの同期を維持するプロセスを作成します。
このプロジェクトの対象外となる作業:
- このプロジェクトでは、同じ材料に対して異なるスペルや名前が相互リンクするプロセスは作成されません。
- このプロジェクトでは GitHub のチュートリアルを作成しません。代わりに、関連する有用な既存の資料にリンクしています。
このプロジェクトには 2 人の有力なテクニカル ライティング候補がいますが、この作業の完了には 3 か月かかると推定しています。GloriousPickle PickleDocs SIG と @GloriousPicklePat(材料追加 API のコア メンテナンス担当者)は、このプロジェクトのサポートを約束しています。
プロジェクトの成功を測定する
新しいドキュメントが問題の解決に役立ったかどうかは、どのように確認できますか?どのような指標を使用し、どのように追跡しますか?
GloriousPickle は、新しい材料(「ingredient」タグ)を追加または更新するために、四半期に平均 10 件の pull リクエストを受け取ります。これらの pull リクエストの大半(60% 以上)は、以前の投稿者からのものです。この改善されたドキュメントにより、新しいコントリビューターからの pull リクエストと pull リクエストの増加が実現すると確信しています。また、積極的に活動してくださった協力者のほとんどは、元々の要素を追加することから始めているため、このドキュメントを改善することで、全体としてより積極的な貢献者になってもらえると考えています。
ドキュメントの公開後、毎月 2 つの指標(材料関連の pull リクエストの数と新しいコントリビューターからの pull リクエストの回数)を追跡します。ドキュメントの公開後、四半期ごとに、合計で 3 回以上の貢献をしたコントリビューターの数も追跡します。
新しいドキュメントの発行後、以下の場合にプロジェクトは成功したとみなされます。
- 材料関連の pull リクエストが 20% 増加
- 新しいコントリビューターからの pull リクエストの数が 15% 増加
- 3 回を超える貢献をしたコントリビューターの数が(ドキュメントの公開後の四半期から)10% 増加する
タイムライン
この作業にかかる時間はどれくらいですか?テクニカル ライターのタスクを月/週ごとに分類できますか?
プロジェクト自体が完了するまでに約 6 か月かかります。テクニカル ライターが採用されると、1 か月かけてテクニカル ライターのオリエンテーションを行い、監査とフリクション ログに移ります。この数か月はドキュメントの作成に集中します。
日付 | アクション アイテム |
---|---|
5 月 | オリエンテーション |
6~8 月 | 既存のドキュメントの監査と摩擦ログの作成 |
9 月~ 10 月 | ドキュメントの作成 |
11 月 | プロジェクトの完了 |
プロジェクトの予算
全般的なガイドライン
- 予算は提案書に記載することも、別のリンクとして追加することもできます。予算が 10 アイテム未満の場合は、提案にアイテムを含めることをおすすめします。
- 予算はすべて米ドルで記載する必要がある。助成金の範囲は 5,000 米ドルから 15,000 米ドルの範囲が推奨されます。プロジェクトがこの範囲を外れる場合は、予算の理由がわかる追加情報をご提供ください。
- 予算の大部分(最低 60 ~ 70%)はプロジェクトを担当するテクニカル ライターに割り当てると想定されます。可能な場合は、プロジェクトごとに予算を設定することをおすすめします。
- オープンソース プロジェクトでは、可能な限りオープンソース ツールを使用するよう想定しています。独自ソフトウェアのライセンスやサポートのための資金がどうしても必要な場合は、その金額の理由を記載してください。
- その他に考えられる費用は次のとおりです。
- ブランディング、ロゴ、テンプレートなど、ドキュメント サイト用のデザイン アセットを作成するためのデザインを作成します
- プロジェクト グッズ(参加者用の T シャツまたはステッカー)の最低額(200 米ドル未満)。シーズンの Google ドキュメントのロゴを使用する場合は、プロジェクトまたは組織のロゴまたは名前を付ける必要があります。グッズに Google という名称は使用できません。
- プロジェクトでかなりのメンターシップや指導の役割を果たすボランティアに対して、最小限の給与を支払う(ボランティア 1 人あたり 500 ドル以下を推奨)
- 他のオープンソース プロジェクトへの下流への寄付は、予算合計の 10% を超えないようにする必要があります。
- 必要に応じて、他の予算項目と、求める金額の理由も記載します。経費の理由では、その支出がプロジェクト全体の成功にどのように貢献するかを強調する必要があります。
予算のサンプル
予算アイテム | 金額 | 累計 | メモ/理由 |
---|---|---|---|
GloriousPickle の成分追加プロセスに関するテクニカル ライターの監査、更新、テスト、新しいドキュメント公開 | 5,000.00 | 5,000.00 | |
ボランティアの給付金 | 500 | 6500.00 | ボランティア給与 3 名 x 各 500 |
プロジェクト T シャツ(10 枚) | 150.00 | 6,650.00 | |
巨大なインフレータブル ユニコーン(15 フィート版) | 99.99 | 6,749.99 | プロジェクト開発期間中に、テクニカル ライターの質問に最速で回答するチームに、インフレータブル ユニコーンを与えます。 |
合計 | 6,749.99 |
詳細情報
提案に関連する追加情報があれば、ここに入力してください。
テクニカル ライターまたはドキュメントに関する過去の経験: ご自身またはメンターが以前にテクニカル ライターと作業したことがある場合、またはドキュメントを作成したことがある場合は、そのことをアプリケーションに記載します。作成したドキュメントと、テクニカル ライターとともに行った方法を説明する。たとえば、使用したレビュー プロセスや、テクニカル ライターのスキルがプロジェクトにどのように役立ったかを説明してください。これまでの経験が、Google ドキュメントのシーズンでテクニカル ライターと連携する際にどのように役立つかを説明します。
ドキュメントのシーズン、Google Summer of Code などへの過去の参加: ご自身またはメンターが Google Summer of Code または同様のプログラムに参加している場合は、応募時にその旨を明記してください。そのプログラムでの実績について説明してください。この経験が Google ドキュメントのシーズンでの仕事の進め方にどう影響するかを説明する。