組織の提案の作成

現在のフェーズ:
結果が発表されました。タイムラインをご覧ください。

このガイドをテンプレートとして使用して、組織のプロジェクト提案書を作成します。

提案書のタイトル - 組織名

提案書のタイトルは短く具体的にする必要があります。「ORGNAME コントリビューター ガイドの更新」は、適切なプロポーザル タイトルです。「ドキュメントの改善」があいまいで、「コントリビューター ガイドのセクション 5、7、23、99 を更新する」、「よくある質問を作成する」、「スタイルガイドを作成する」が長すぎる

組織について

このセクションでは、組織またはプロジェクトについて、短い段落で説明してください。プロジェクトが解決する問題は何ですか?ユーザーとコントリビューターは誰ですか?組織またはプロジェクトの存続期間はどのくらいですか?提案の資金提供がオープンソースと世界にプラスの影響を与える理由を理解できるように、コンテキストを説明してください。

GloriousPickle(現在のバージョン 1.2.3、2009 年に初リリース)は、MIT ライセンスのライブラリで、あらゆる漬物に適した野菜の塩、砂糖、酢、スパイスの完璧な比率を、1 つの小さなキュウリからコンテナ船に積まれた大根まで、簡単に計算できます。コントリビューターは世界中のピクルス愛好家で、ユーザーは家庭料理のシェフ、レストランのシェフ、大規模な食品加工会社や組織のロジスティクス担当者です。最大のユーザーは、フードバンクが保存期間の短い野菜を安定したピクルス瓶に変え、多くのコミュニティで飢餓に苦しむ人々に食料を提供するとともに、食品廃棄物を削減する活動を支援する組織です。また、ユーザーは GloriousPickle の使用状況に関する指標を Google に送信できます。Google は、この指標を使用して、機械学習によって新しいピクルス レシピを作成する大規模なデータセットである PickleSet を生成します。

プロジェクトについて

プロジェクトの問題

プロジェクトが解決する問題について説明してください。この問題を解決することが組織またはプロジェクトにとって重要な理由は何ですか。

ユーザーは、新しいスパイスやその他の食材(特にヨーロッパ以外の料理の食材)に関する情報を GloriousPickle ツールに追加したいと考えています。残念ながら、この情報を追加するプロセスは十分に文書化されていません。つまり、コントリビューターはサポートを得るためにプロジェクトで問題を報告する必要があります(または、あきらめることになります)。また、このプロセスでは、コントリビューターが pull リクエスト プロセスと GitHub にすでに精通していることを前提としています。ただし、多くのユーザーはプロの開発者ではありません。

材料情報が多いほど、GlloriousPickle がすべてのユーザーにとってより有益なものになります。

プロジェクトの範囲

組織で作成、更新、改善するドキュメントについて教えてください。意図的に作業を行っていない場合は、その情報も含めます。推定所要時間と、プロジェクトの作業を担当する組織のボランティアやテクニカル ライターをすでに特定しているかどうかを記載します。

GloriousPickle プロジェクト(コード名: PicklePlus)は、次の機能を提供します。

  • 既存のドキュメントを監査し、3 つの主要なユースケース(新しい材料の追加、バリエーションの材料の追加、材料に関する情報の更新または修正)について、現在のドキュメントの摩擦ログを作成します。
  • 摩擦ログをガイドとして、ドキュメントのギャップを把握し、上位のユースケースに関するドキュメントを更新します。
  • pull リクエストと GitHub を初めて使用するコントリビューターがプロセスを使いこなせるよう、簡単な「クイック リファレンス」を作成します。
  • ドキュメントのテスター(プロジェクトのボランティア)や広範な GloriousPickle コミュニティからのフィードバックを取り入れます。
  • リリース チームと連携して、GloriousPickle サイトのドキュメントを更新し、今後ドキュメントを更新ツールと同期させるプロセスを作成します。

このプロジェクトの対象外の作業:

  • このプロジェクトでは、同じ成分の異なるスペルや名前を相互リンクするプロセスは作成されません。
  • このプロジェクトでは、GitHub のチュートリアルは作成されません。代わりに、関連する有用な既存の資料にリンクされます。

このプロジェクトには優秀な技術文書作成担当者が 2 人おり、この作業の完了には 3 か月かかると見込まれます。GloriousPickle PickleDocs SIG と @GloriousPicklePat(成分追加 API のコア メンテナー)がプロジェクトのサポートを約束しています。

プロジェクトの成功を測定する

新しいドキュメントが問題の解決に役立ったかどうかを判断する方法どの指標を使用し、どのように追跡しますか?

GloriousPickle には、新しい材料を追加または更新する pull リクエスト(「ingredient」というタグが付いています)が四半期に平均 10 件届きます。これらの pull リクエストの大部分(60% 超)は、以前の貢献者によるものです。この改善されたドキュメントにより、新たなコントリビューターからの pull リクエストと pull リクエストが増えると考えられます。積極的な貢献者のほとんどが材料の追加から始まっているため、このドキュメントを改善することで、全体としてさらに積極的な貢献者が増えるとも考えています。

ドキュメントの公開後、Google は 2 つの指標(コンポーネント関連のプルリクエスト数と新規コントリビューターからのプルリクエスト数)を毎月追跡します。また、ドキュメントが公開されてから四半期ごとに、全体で 3 回以上貢献したコントリビューターの数も追跡されます。

新しいドキュメントの公開後に、次の条件が満たされていれば、プロジェクトは成功と見なされます。

  • 成分関連の pull リクエスト数が 20% 増加
  • 新しいコントリビューターからのプルリクエスト数が 15% 増加
  • 3 件以上の貢献を行ったコントリビューターの数が 10% 増加する(ドキュメント発行後の四半期から)

タイムライン

この作業にかかる時間はどれくらいですか?テクニカル ライターのタスクを月や週ごとに分類できますか?

プロジェクト自体の所要時間は約 6 か月です。テクニカル ライターを採用したら、1 か月間テクニカル ライターのオリエンテーションを行い、その後監査と摩擦ログに移行し、最後の数か月はドキュメントの作成に集中します。

日付 アクション アイテム
5 月 向き
6~8 月 既存のドキュメントを監査し、摩擦ログを作成する
9 月~ 10 月 ドキュメントを作成する
11 月 プロジェクトの完了

プロジェクトの予算

一般的なガイドライン

  • 予算は提案書に、または個別のリンクとして記載できます。予算が 10 個未満の場合は、提案書に含めることをおすすめします。
  • 予算はすべて米ドルで設定する必要があります。助成金の範囲は 5,000 ~ 15,000 米ドルです。プロジェクトがその範囲外の場合は、予算の根拠となる追加情報をご提供ください。
  • 予算の大部分(最低 60 ~ 70%)は、プロジェクトに携わる技術ライターに割り当てられると想定されます。可能な限り、プロジェクトごとに予算を立てることをおすすめします。
  • Google は、オープンソース プロジェクトが可能な限りオープンソース ツールを使用することを想定しています。独自ソフトウェアのライセンスまたはサポートの資金がどうしても必要な場合は、その理由も記入してください。
  • その他の費用には次のようなものがあります。
    • ドキュメント サイトのブランディング、ロゴ、テンプレートなどのデザイン アセットを作成するデザイン作業
    • プロジェクトの記念品(参加者向けの T シャツやステッカー)の最低額(200 米ドル未満)。Google シーズンの Google ドキュメントのロゴを使用する場合は、プロジェクトまたは組織のロゴまたは名前とともに使用する必要があります。グッズに Google の名前を使用することはできません
    • プロジェクトでメンターや指導者として重要な役割を担うボランティアへの最低限の報酬(ボランティア 1 人につき 500 ドル以下をおすすめします)
    • 他のオープンソース プロジェクトへのダウンストリームの寄付は、予算の合計の 10% 以下にする必要があります。
  • 必要に応じて、他の予算項目と、申請する金額の根拠を記載します。費用の正当化では、支出がプロジェクト全体の成功にどのように貢献するかを強調する必要があります。

予算のサンプル

予算項目 金額 総掲載数 注記/理由
GloriousPickle の材料追加プロセスに関するテクニカル ライターの監査、更新、テスト、新しいドキュメントの公開 5,000.00 5,000.00
ボランティア手当 500 6,500.00 ボランティア手当 3 回分 x 500 円
プロジェクト T シャツ(10 枚) 15,000 6,650.00
巨大なインフレータブル ユニコーン(15 フィート バージョン) 99.99 6,749.99 プロジェクト開発期間中に、テクニカル ライターの質問に最速で回答したチームに、インフレータブル ユニコーンを授与します
合計 6,749.99

その他の情報

提案に関連する追加情報をここに含めます。

  • テクニカル ライターまたはドキュメントに関するこれまでの経験: 自分自身またはメンターがテクニカル ライターと連携した経験がある場合や、ドキュメントを作成した経験がある場合は、申請時にその旨を記載してください。作成したドキュメントと、技術ライターとの連携方法について説明します。たとえば、使用したレビュー プロセスや、技術ライターのスキルがプロジェクトにどのように役立ったかについて説明します。これまでの経験が、Google Season of Docs でテクニカル ライターと連携するうえでどのように役立つかを説明します。

  • Google Season of Docs、Google Summer of Code などのプログラムへの参加歴:自分またはメンターのいずれかが Google Summer of Code などのプログラムに参加したことがあれば、申請時にその旨を記載してください。そのプログラムでの実績について説明します。このエクスペリエンスが Google シーズンの Google ドキュメントでの働き方にどのように影響する可能性があるかを説明します。