現在のフェーズ:
2021 シーズンのドキュメント プログラムは、2021 年 12 月 14 日に終了しました。タイムラインをご覧ください。
このガイドは、2021 シーズン Google ドキュメント プログラムに申し込み、または参加している組織管理者を対象としています。
貴組織は 2021 シーズンの Google ドキュメント プログラムに参加する必要がありますか?
以下の質問を使用して、自分のオープンソース プロジェクトや組織が「ドキュメント シーズン」に参加すべきかどうかを判断してください。
組織またはプロジェクトは:
- 新規のドキュメントや更新されたドキュメントが、プロジェクトやコミュニティの目標達成や問題の解決に役立つとお考えですか?
- ドキュメント プロジェクトの成功をどのように測定するかについて、最初の理解または仮説はあるか。
- テクニカル ライターの採用、評価、オンボーディングに協力してくれるコミュニティ メンバーがいますか?また、プロジェクト期間中(申請期間を含めて 6 ~ 8 か月)質問に答え、その他のサポートを提供してくれる人はいますか?
- 組織管理者の役割を果たし、アプリケーションの作成、プログラム管理者からの質問への対応、月次評価と最終評価とケーススタディの提出を手配する意欲のあるコミュニティ メンバーがいますか?また、組織管理者は、2021 年度のドキュメント シーズン終了後、フォローアップ アンケートに進んで回答する必要があります。
また、Open Collective アカウントを作成できることなど、プログラムの資格要件も満たしている必要があります。
組織の申請プロセス
調査フェーズ
2021 シーズンの Google ドキュメントのお申し込みは 2021 年 2 月 9 日に開始されますが、申請書を提出する前に時間をかけて探索フェーズの手順を完了することを強くおすすめします。
- [プロジェクト提案書を作成] ページ。[プロポーザル] ページには、主なニーズ、目標、問題、考えられる解決策、指標が記載されています。このページは一般公開し、コミュニティによる貢献やディスカッションが可能なものにする必要があります。参加を希望するテクニカル ライター向けの情報を記載してください。テクニカル ライターは、どこで質問するべきか、関心を示すべきか、プロジェクトの詳細を知るべきかなどを記載してください。(例については、プロジェクトのアイデアのリストをご覧ください)。
- コミュニティ チャンネルで提案ページを公開し、「シーズンの Google ドキュメント」の GitHub リポジトリで関心のある組織のリストに組織を追加します。また、Write The Docs Slack の #season-of-docs チャンネルでリンクを共有することもできます。プロモーションとプレスページには、ドキュメントのシーズンについて紹介する際に使用できるロゴやその他のコンテンツを掲載しています。
- ドキュメントのアイデアごとに、テクニカル ライターがコミュニティや組織とうまく連携するためにどのような経験と資格が必要かを検討します。テクニカル ライターが(GitHub やドキュメント ツールチェーンを使用するなどして)開発するのを、コミュニティはどのようなスキルで支援できますか?(テクニカル ライター向けのサポート ガイドをご覧ください。
- 興味を持ったテクニカル ライターからの質問に答えてくれる有志を募ります。
- プロジェクトへの参加に興味があるテクニカル ライターが送信した関心に関する記述を確認します。
申請フェーズ
- 提案ページから最も有望なアイデアを選択します。組織ごとに 1 つの提案しか提出できません。次の点に注意してください。
- テクニカル ライターが最も関心を引いているアイデアはどれですか。
- プロジェクトの最大の問題を解決するのに役立つアイデアは、次のうちどれですか。完了する可能性は高いものの、プロジェクトに大きな違いを生まないドキュメント プロジェクトのアイデアよりも、リスクの高いアイデアを選択することをおすすめします。
- アイデアを得るには、コミュニティの特定のメンバーが参加する必要がありますか?参加する時間はありますか?
プロポーザル テンプレートを使用してプロポーザルを作成します。 以下の点を理解し、含めるようにしてください。
- 対処する問題
- 改善または作成するドキュメントの範囲
- ドキュメントの成功を測定する方法
プロポーザルには予算も含める必要があります。 提案が不完全な場合、その提案は考慮されません。
申請期限の 2021 年 3 月 26 日 18:00(UTC)までに申請フォームを送信してください。承認された提案は 2021 年 4 月 16 日に発表されます。
プロジェクトの開発と報告
プロジェクトのキックオフ
- 組織ですでにプロジェクトのテクニカル ライターを指名している場合は、テクニカル ライターとキックオフ ミーティングを行います。テクニカル ライターと協力して、作業と定期的なチェックインのスケジュールを作成する必要があります。
- 関心のあるテクニカル ライターから複数の関心の表明を受けた場合は、テクニカル ライターの選定を公表するか、決定内容を申請者に伝えます。
支払いの付与
- シーズン オブ ドキュメントでは、2021 年 6 月 10 日より、テクニカル ライターを雇うと、各組織の Open Collective アカウントに助成金の 40% が入金されます。組織は、プロジェクトのマイルストーンに基づいて、テクニカル ライターとともに支払いスケジュールを作成することをおすすめします。これには、プロジェクトのキックオフ時の支払いも含まれます。
- 残りの 60% は、2021 年 12 月 14 日以降、最終評価とケーススタディを完成させて提出した組織の Open Collective アカウントに入金されます。
- Open Collective アカウントの作成について詳しくは、お支払いガイドをご覧ください。
プロジェクト ステータス レポート
- 組織管理者は、ステータス レポート フォームへのリンクを受け取ってから 1 週間以内に、月次ステータス レポートに記入する必要があります(リンクはメールで送信されるため、迷惑メールフォルダをご確認ください)。
プロジェクトの最終評価と事例紹介
資金の残額を受け取るには、2021 年 11 月 30 日 18:00(UTC)までにプロジェクトの最終評価とケーススタディの両方を完成させて提出する必要があります。
最終評価
最終評価フォームは、遅くとも 1 か月前の 2021 年 11 月 30 日 18:00(UTC)までに組織管理者に提供されます。
事例紹介
「ドキュメント シーズン」の事例紹介は、ドキュメント シーズン 2021 への組織の主な成果物です。プロジェクトの更新を毎週記録しておくと ケーススタディの作成に役立ちます毎週、プロジェクトの進捗状況(pull リクエスト、問題、会話へのリンク(役立つ場合)、良かった点(または悪かった点)、学んだこと、質問した内容を記録します。
詳しくは、事例紹介の作成をご覧ください。また、事例紹介テンプレートに沿って事例紹介を作成してください。事例紹介は、最終評価フォームにリンクとして提出してください。
事例紹介は Season of Docs サイトで公開されるため、プロジェクトに関する情報を含めるときはその点に留意してください。
組織には Season of Docs プロジェクトの実績を時系列で追跡するため、少なくとも 3 回のフォローアップ アンケートへの回答をお願いしています。
フォーム
形態 | リンク | 期限 |
---|---|---|
組織のアプリケーション | 組織へのお申し込みは終了しました。season-of-docs-announce のお知らせ用メーリング リストに参加して、最新情報を入手してください。 |
2021 年 3 月 26 日 18:00 UTC |
組織のお支払い情報 | 2021 年 5 月 12 日 18:00 UTC | |
テクニカル ライターの採用を証明するもの | 2021 年 5 月 17 日 18:00 UTC | |
毎月の評価 | フォームはプロジェクト評価フェーズ(2024 年 6 月 5 日)で利用可能になります。 |
タイムラインを参照 |
最終的なプロジェクト評価と事例紹介 | フォームはプロジェクトの最終評価と事例紹介のフェーズ(2024 年 11 月 22 日~ 2024 年 12 月 10 日)で利用できます。 |
2021 年 11 月 30 日 18:00 UTC |
フォローアップ アンケート | フォローアップ アンケートの段階(2025 年 5 月 1 日)にフォームを使用可能。 |
タイムラインを参照 |
関連情報
- ドキュメントのシーズンのタイムラインを確認する。