現在のフェーズ:
ドキュメントの作成。タイムラインをご覧ください。
このガイドをテンプレートとして使用し、組織のプロジェクト提案を作成してください。
プロポーザル タイトル - 組織名
提案のタイトルは短く具体的なものにする必要があります。提案のタイトルは「更新版 ORGNAME コントリビューター ガイド」です。「ドキュメントの改善」があいまいすぎるため、「コントリビューター ガイドのセクション 5、7、23、99 の更新、よくある質問の作成、スタイルガイドの作成」は長すぎます。
組織について
このセクションでは、組織またはプロジェクトについて数段落で簡単に説明してください。プロジェクトで解決する問題は何ですか？ユーザーとコントリビューターは誰か。組織またはプロジェクトの設立からどのくらい経ちますか？お客様の提案に資金を投じることが、オープンソースや世界にプラスの影響をもたらす理由を理解できるよう、背景情報をご提供ください。
GloriousPickle（現在のバージョン 1.2.3、2009 年最初のリリース）は MIT ライセンスのライブラリであり、孤立したキュウリ 1 枚からコンテナ輸送までのラディッシュまで、考えられるすべてのピクルス野菜の塩、砂糖、酢、スパイスの完璧な比率を簡単に計算できます。コントリビューターは世界中のピクルス愛好家で、ユーザーはホームシェフ、レストラン シェフ、そして大規模な食品加工企業や組織の物流に従事する人たちです。当社の最大のユーザーは、フードバンクが賞味期限の短い野菜を安定したピクルスの瓶に変えるのを支援し、多くのコミュニティで空腹の人々の食事を支援し、食品廃棄物の削減に貢献しています。さらに、ユーザーは GloriousPickle の使用に関するオプションの指標を送信します。これは、ML を使用して新しい pickle レシピを作成するための大規模なデータセットである PickleSet を作成するために使用されます。
プロジェクトについて
プロジェクトの問題
プロジェクトが解決する問題について教えてください。この問題を解決することが、組織またはプロジェクトにとって重要なのはなぜですか。
ユーザーは、新しいスパイスやその他の食材（特にヨーロッパ以外の料理の食材）に関する情報を GloriousPickle ツールに追加したいと考えています。残念ながら、この情報を追加するプロセスは十分に文書化されていません。つまり、潜在的なコントリビューターは、支援を受けるためにプロジェクトの問題を提起する必要があります（または、完全にあきらめます）。このプロセスは、コントリビューターがすでに Google の pull リクエスト プロセスと GitHub に精通していることを前提としていますが、ユーザーの多くはプロのデベロッパーではありません。
食材の情報が多いほど、GloriousPickle はすべてのユーザーにとってより便利になります。
プロジェクトのスコープ
組織で作成、更新、または改善予定のドキュメントについてお聞かせください。意図的に行われていない作業がある場合は、その情報も含めます。推定所要時間と、プロジェクトに携わる組織のボランティアとテクニカル ライターがすでに決まっているかどうかを記載します。
GloriousPickle プロジェクト（コードネーム PicklePlus）は、以下のことを行います。
- 既存のドキュメントを監査し、3 つの主要なユースケース（新しい材料の追加、バリエーションの材料の追加、材料に関する情報の更新または修正）について、現在のドキュメントの摩擦ログを作成します。
- 摩擦ログをドキュメント内のギャップを理解するためのガイドとして使用し、上位のユースケースについて更新されたドキュメントを作成する。
- クイック「クイック リファレンス」を作成して、pull リクエストを初めて利用するコントリビューターと、GitHub のプロセスを利用できるようにします。
- ドキュメントのテスター（プロジェクトのボランティア）やより広範な GloriousPickle コミュニティからのフィードバックを取り入れます。
- リリースチームと協力して GloriousPickle サイトのドキュメントを更新し、今後は更新ツールと同期したドキュメントを維持するプロセスを作成してください。
このプロジェクトの対象外である作業:
- このプロジェクトでは、同じ材料に異なるつづりや名前を相互リンクさせるプロセスは作成されません。
- このプロジェクトでは GitHub のチュートリアルは作成しません。代わりに、クイック リファレンスには、関連性が高く有用な既存の資料へのリンクが含まれています。
このプロジェクトには、テクニカル ライティングの有能な候補者が 2 人います。この作業が完了するまでに 3 か月かかる見込みです。GloriousPickle PickleDocs SIG と @GloriousPicklePat（材料追加 API のコア メンテナンス チーム）は、このプロジェクトのサポートを約束しています。
プロジェクトの成功を測定する
新しいドキュメントが問題の解決に役立ったかどうかは、どのように確認できますか？どのような指標を使用し、どのように追跡するか。
GloriousPickle は、新しい食材（タグ「ingredient」）を追加または更新する pull リクエストを四半期あたり平均 10 件受け取ります。これらの pull リクエストの大半（60% 以上）は、以前のコントリビューターからのものです。この改善されたドキュメントにより、新しいコントリビューターによる pull リクエストと pull リクエストが増えると考えています。Google の積極的なコントリビューターのほとんどは、材料の追加から始まったため、このドキュメントを改善することで、全体的にアクティブなコントリビューターが増えると考えています。
ドキュメントの公開後、毎月 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」という名前は使用できません。
- プロジェクトでかなりのメンターシップや指導の役割を果たすボランティアに対して、最小限の給与
- 他のオープンソース プロジェクトへの下流への寄付は、予算合計の 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 シーズン ドキュメントでテクニカル ライターと連携する際にどのように役立つかを説明します。
Google シーズン オブ ドキュメントや Google Summer of Code などへの過去の参加: Google Summer of Code または同様のプログラムに参加したことのあるメンターは、申し込み時にその旨を明記してください。そのプログラムでの実績について説明してください。この経験が Google シーズンの Google ドキュメントでの働き方にどのように影響するかを説明してください。