現在のフェーズ:
2021 Season of Docs プログラムは、2021 年 12 月 14 日に終了しました。タイムラインをご覧ください。
このガイドをテンプレートとして使用して、組織のプロジェクト提案書を作成します。
提案書のタイトル - 組織名
提案書のタイトルは短く具体的にする必要があります。「ORGNAME コントリビューター ガイドの更新」は、適切なプロポーザル タイトルです。「ドキュメントの改善」があいまいで、「コントリビューター ガイドのセクション 5、7、23、99 を更新する」、「よくある質問を作成する」、「スタイルガイドを作成する」が長すぎる
組織について
このセクションでは、組織またはプロジェクトについて、短い段落で説明してください。プロジェクトが解決する問題は何ですか？ユーザーとコントリビューターは誰ですか？組織またはプロジェクトの存続期間はどのくらいですか？提案の資金提供がオープンソースと世界にプラスの影響を与える理由を理解できるように、コンテキストを説明してください。
GloriousPickle（現在のバージョン 1.2.3、2009 年に初リリース）は、MIT ライセンスのライブラリで、あらゆる漬物に適した野菜の塩、砂糖、酢、スパイスの完璧な比率を、1 つの小さなキュウリからコンテナ船に積まれた大根まで、簡単に計算できます。コントリビューターは世界中のピクルス愛好家で、ユーザーは家庭料理のシェフ、レストランのシェフ、大規模な食品加工会社や組織のロジスティクス担当者です。最大のユーザーは、フードバンクが保存期間の短い野菜を安定したピクルス瓶に変え、多くのコミュニティで飢餓に苦しむ人々に食料を提供するとともに、食品廃棄物を削減する活動を支援する組織です。また、ユーザーは GloriousPickle の使用状況に関する指標を Google に送信できます。Google は、この指標を使用して、機械学習によって新しいピクルス レシピを作成する大規模なデータセットである PickleSet を生成します。
プロジェクトについて
プロジェクトの問題
プロジェクトで解決する問題について教えてください。この問題を解決することが、組織やプロジェクトにとって重要なのはなぜですか。
ユーザーは、新しいスパイスやその他の食材（特にヨーロッパ以外の料理の食材）に関する情報を GloriousPickle ツールに追加したいと考えています。残念ながら、この情報を追加するプロセスは十分に文書化されていません。つまり、コントリビューターはサポートを得るためにプロジェクトで問題を報告する必要があります（または、あきらめることになります）。また、このプロセスでは、コントリビューターが pull リクエスト プロセスと GitHub にすでに精通していることを前提としています。ただし、多くのユーザーはプロの開発者ではありません。
材料に関する情報を多く提供していただければ、すべてのユーザーにとって GloriousPickle がより有用なものになります。
プロジェクトの範囲
組織でどのようなドキュメントを作成、更新、改善するのかを教えてください。意図的に作業を行っていない場合は、その情報も含めます。所要時間と、プロジェクトに協力する組織のボランティアと技術ライターをすでに特定しているかどうかを記載します。
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% 増加
- 新しいコントリビューターからの pull リクエストの数が 15% 増加
- 3 回を超える貢献をしたコントリビューターの数が 10% 増加する（ドキュメントの公開後の四半期から）
プロジェクトの予算
一般的なガイドライン
- 予算はプロポーザルに含めるか、別のリンクとして含めることができます。予算が 10 個未満の場合は、提案書に含めることをおすすめします。
- 予算はすべて米ドルで設定する必要があります。助成金の範囲は 5,000 ～ 15,000 米ドルです。プロジェクトがその範囲外の場合は、予算の根拠となる追加情報をご提供ください。
- 予算の大部分（最低 60 ～ 70%）は、プロジェクトに携わる技術ライターに割り当てられると想定されます。可能な限り、プロジェクトごとに予算を立てることをおすすめします。
- オープンソース プロジェクトでは、可能な限りオープンソース ツールを使用することをおすすめします。プロジェクトで独自のソフトウェア ライセンスやサポートに資金が絶対に必要な場合は、その金額の根拠を記載してください。
- その他の費用には次のようなものがあります。
- ドキュメント サイトのブランディング、ロゴ、テンプレートなどのデザイン アセットを作成するためのデザイン
- プロジェクト グッズ（参加者用の T シャツやステッカー）の最小額（200 米ドル未満）。Season of Docs のロゴを使用する場合は、プロジェクトまたは組織のロゴまたは名前を併用する必要があります。記念品で Google の名称を使用することはできません。
- プロジェクトでメンターや指導者として重要な役割を担うボランティアへの最低限の報酬（ボランティア 1 人につき 500 ドル以下をおすすめします）
- 他のオープンソース プロジェクトへのダウンストリームの寄付は、予算の合計の 10% 以下にする必要があります。
- 必要に応じて、その他の予算項目とその理由を記載します。費用の正当化では、支出がプロジェクト全体の成功にどのように貢献するかを強調する必要があります。
予算のサンプル
| 予算項目 | 金額 | 総掲載数 | 注記/理由 |
|---|---|---|---|
| 技術ライターが GloriousPickle の材料の追加プロセスに関する新しいドキュメントを監査、更新、テストして公開します | 5,000.00 | 5,000.00 | |
| ボランティア手当 | 500 | 6,500.00 | ボランティアの補助金 3 件 × 各 500 |
| プロジェクト T シャツ（T シャツ 10 枚） | 150.00 | 6,650.00 | |
| ジャイアント インフレータブル ユニコーン（4 m バージョン） | 99.99 | 6,749.99 | プロジェクトの開発期間中にテクニカル ライターの質問に最も早く回答したチームに、空気で膨らませるユニコーンをプレゼントします。 |
| 合計 | 6,749.99 |
その他の情報
提案に関連する追加情報をここに含めます。
テクニカル ライターやドキュメントでの過去の経験: ご自身またはメンターがテクニカル ライターと仕事をした経験がある場合や、ドキュメントを作成したことがある場合は、申請書にその旨を記載してください。作成したドキュメントと、技術ライターとの連携方法について説明します。たとえば、使用したレビュー プロセスや、技術ライターのスキルがプロジェクトにどのように役立ったかについて説明します。これまでの経験が、Google Season of Docs でテクニカル ライターと連携するうえでどのように役立つかを説明します。
Season of Docs、Google Summer of Code などに参加したことがある: ご自身またはメンターが Google Summer of Code または同様のプログラムに参加している場合は、応募時にその旨を記載してください。そのプログラムでの実績について説明します。この経験が Google Season of Docs での働き方にどのように影響するかを説明します。