現在のフェーズ:
2021 年の Season of Docs プログラムは 2021 年 12 月 14 日に終了しました。タイムラインをご覧ください。
Season of Docs について
Season of Docs は、Google オープンソース プログラム オフィスが管理する持続可能性プログラムです。Season of Docs の目標は次のとおりです。
- オープンソース プロジェクトをサポートし、ドキュメントを使用してプロジェクトの問題を解決する
- 技術ライターにオープンソースの経験を積む機会を提供する
- オープンソース、ドキュメント、技術的な文章の認知度を高める
- オープンソースのドキュメントで効果的な指標に関する情報を収集して共有する
ドキュメンタリー シーズンの詳細については、プログラムのウェブサイトをご覧ください。
2021 年のプログラムの概要
2021 年のプログラムの変更点
2019 年と 2020 年、組織と技術ライターはそれぞれ Season of Docs プログラムに個別に申し込み、技術ライターは Season of Docs プログラム管理者によって組織とマッチングされました。組織は、技術ライターと連携するメンターを提供しました。技術ライターは、勤務地に応じて業務に対して手当を受け取りました。このプログラムでは、技術ライター、メンター、組織管理者がプログラムへの参加に満足しているかどうかを測定しましたが、ドキュメントの成果は測定していません。
2021 年、Season of Docs チームはプログラムに大幅な変更を加えました。ドキュメントの成果の測定に重点を移し、組織と技術ライターに柔軟性を持たせました。
- 予算と提案指標を含むプロジェクト プロポーザルを提出した組織
- 技術ライターは、Google を通じて組織とのマッチングを申請するのではなく、承認された組織に直接申請するようになりました
- 承認された組織は Open Collective を通じて助成金を受け取り、技術ライターに支払いを行いました。
- テクニカル ライターの報酬は組織によって設定されている
- 組織が最終評価とケーススタディを提出し、フォローアップ アンケートに回答した
2021 年の一般的な検出結果
組織
- 2021 年のプログラムの変更により、申請する組織は減少しました（2021 年は 2020 年と比較して 30% 減少）。しかし、2021 年の組織管理者は、2020 年の管理者よりもプログラムに少し満足していました（93% 対 91%）。
問題、ドキュメント タイプ、指標
- ほとんどのプロジェクトは、（問題や質問を減らすことで）メンテナーの負担を軽減したり、（プロジェクト ユーザーやコントリビューターによる）プロジェクトへの参加を促進したりするためにドキュメントの作成に重点を置いています。
- 承認された組織の 50% が、チュートリアルやハウツーのコンテンツを作成しました。
- 承認された組織の 50% 以上が、現在のドキュメントが不十分、整理されていない、古くなっていると考えています。
- プロジェクトでは一般的に、ドキュメントの有効性をインタラクションを通じて測定したいと考えています。特に、問題の発生が減り、ドキュメントへのアクセスやプロジェクトへの参加が増えることを重視しています。
- 2022 年 11 月現在、30 件中 25 件のプロジェクトが回答しています。
- 18 件のプロジェクトが、元の指標を達成したと回答しています
- 5 件のプロジェクトが改訂された指標を満たしていた
- 2 件のプロジェクトは、まだ判断するには早すぎると回答しています。
プログラムへの参加
- 組織管理者にとって、技術ライターの募集、採用、支払いは、プログラムで最も困難な部分でした。
- 2022 年 11 月時点で、30 社中 24 社が回答しています。
- 18 の組織が、引き続きドキュメント シーズンのテクニカル ライターと連携しています（継続的なコントリビューターとして、または質問に回答するリソースとして）。
- 4 つの組織が、有給の役割でドキュメント シーズンの技術ライターと連携していました
- 18 の組織が、引き続きドキュメント シーズンのテクニカル ライターと連携しています（継続的なコントリビューターとして、または質問に回答するリソースとして）。
2021 年のハイライト
- 複数のプロジェクトで、テクニカル ライターが Season of Docs プログラムの終了後もプロジェクトで働き続ける意向を示しています。
- Metanorma には、資格要件を満たすテクニカル ライターが多数応募したため、プログラム期間中に Season of Docs でサポートされているライターと一緒に働くために、追加のライターを雇用するためのマッチング ファンドを見つけました。
- Moja Global は、コミュニティがドキュメントに非常に関心を持っていることを確認したうえで、より多くのコントリビューターがプロジェクトのドキュメント作成に参加できるように、新しいドキュメント ワーキング グループを立ち上げました。
2021 年の概要データ
2021 年には 82 の組織が申請し、30 のオープンソース組織がプログラムに承認されました。（選定基準については、申請書の作成ガイドをご覧ください）。参加組織の一覧については、Season of Docs ウェブサイトをご覧ください。承認された 30 の組織はすべて、最終的な事例紹介レポートを提出して、2021 年のプログラムへの参加を完了しました。
組織について
Season of Docs 2021 に参加した組織は、さまざまなオープンソース プロジェクトを代表しています。2021 年のコホートには、次のものが含まれています。
- Julia、Perl、R などの大規模言語プロジェクト
- 教育、気候、フィンテック、ヘルスケア、図書館サービス、機械学習、質量分析、公共契約、ロボティクスのプロジェクト
- デベロッパー向けのプロジェクト（カオス エンジニアリング ツール、ファジングツール、チャットボット SDK、ソフトウェア構成分析パイプライン、パフォーマンス モニタリング ツール、ビジュアル プログラミング ツールなど）
- ドキュメント ツール（Redocly、Metanorma など）のドキュメント プロジェクト
Python エコシステム プロジェクトが最大のサブカテゴリでした。2021 年のコホートには、Arviz、NumPy、MicroPython、PyMC3、PyTorch-Ignite、SymPy が含まれていました。
Google は、プロジェクトに関するメタデータ（設立日、コントリビューターの地域分布、コントリビューターの数、ユーザーベースの規模など）を収集していません。
プロジェクトには、使用しているオープンソース ライセンスを示すことを求めました。
2021 年の組織が指摘したドキュメントの問題は、オープンソース プロジェクトと一般的な技術ドキュメントの両方で非常に一般的な問題です。
2021 年のプログラムで解決を希望した主な問題は次のとおりです。
組織が複数のドキュメントの問題を報告する場合があります。詳しくは、Season of Docs 2021 の結果ページをご覧ください。各組織の詳細なケーススタディへのリンクが掲載されています。
作成されるドキュメントの種類
2021 年のケーススタディで最も多く言及されたドキュメント タイプはチュートリアルでした。
ケーススタディで言及されているその他のドキュメント タイプには、コードとしてのドキュメント パイプライン、図、用語集、スタイルガイド、よくある質問、国際化、Codelab、コンテンツモデル、モジュール、コンセプト ドキュメント、エラー メッセージ、ユーザー調査、Readme、ナレッジベースなどがあります。
これらのカテゴリの一部は曖昧であり、1 つのドキュメント プロジェクトに複数のドキュメント タイプや機能が含まれる場合があります。
いくつかのプロジェクトでは、ドキュメント タイプの計画のガイドとして Diátaxis フレームワークを使用していることを明記しています。
詳しくは、Season of Docs 2021 の結果ページをご覧ください。各組織の詳細なケーススタディへのリンクが掲載されています。
予算
2021 年の予算リクエストの平均額は 10,200 ドルで、中央値は 10,000 ドルでした。最大限の助成金（$15,000）を申請して受け取ったのは 3 つの組織のみで、最小限の助成金（$5,000）を申請したのは 3 つの組織でした。
指標
プロジェクトは、ドキュメント プロジェクトの成功を測定するために使用していた指標を事例紹介で説明しています。
提案された上位の指標は次のとおりです。
提案されたその他の指標には、GitHub のスター数、ページでの滞在時間、メーリング リストのコンバージョン、定性的なユーザーテスト、フォーラムの参加者数、パートナー/ボランティア/統合の数などがあります。
技術的な文章作成プロジェクトの終了から事例紹介の提出までの期間が短かったため、2021 年度のほとんどの参加者は、最初の指標が達成されたかどうかを判断するのに十分なデータを収集できませんでした。
詳しくは、Season of Docs 2021 の結果ページをご覧ください。各組織の詳細なケーススタディへのリンクが掲載されています。
技術ライターとの連携
2021 年のドキュメント シーズン プログラムの最大の変更点は、プロジェクトが技術ライターと連携する方法にありました。以前のシーズンでは、テクニカル ライターは Google に直接応募し、プログラム管理者がプロジェクトとマッチングさせ、Google から直接定額の奨励金を受け取っていました。
2021 年、技術ライターはプロジェクトに直接応募し、プロジェクトは技術ライターの報酬の予算を設定し、支払いは Season of Docs の Open Collective ファンドを通じて行われました。
2021 年のプログラムに参加したプロジェクトのほとんどは、技術ライターの採用や雇用にほとんどまたはまったく経験がなく、多くのプロジェクトが、このプロセスの部分にさらにサポートが必要であると指摘しています。このフィードバックを受けて、ドキュメント シーズン チームは、プログラム ガイドに技術ライター契約の作成に関するドキュメントを追加しました。
採用に関する推奨事項
プロジェクトには、シーズン オブ ドキュメントへの参加に興味がある他のプロジェクトを推薦するよう依頼されました。主な採用推奨事項は次のとおりです。
- プログラムへの参加が承認される前でも、できるだけ早く技術ライター向けの採用資料を共有してください。候補者を紹介するようコミュニティに依頼する。
- プロジェクト チャネルの外部で広く共有します。インクルーシブな言葉遣いを使用し、underrepresented background の候補者を直接応募するよう促します。
- ドキュメント作成プロセスに不可欠なツールを把握し、それらのツールの使用経験がある技術ライターを採用します。
- 成果物とマイルストーン、コミュニケーション チャネルとチェックイン、支払いプロセスとタイミングについて、技術ライターに対して明確な期待値を設定します。
- コミュニティ メンバーに投資し、テクニカル ライターとして成長できるようサポートすることを検討してください。Season of Docs のテクニカル ライターを利用して、メンターシップとコーチングを提供します。
- 特に、テクニカル ライターがプロジェクトのドメインで以前に経験がない場合は、テクニカル ライターのオンボーディング、質問への回答、プログラム中のサポートに予想よりも多くの時間を割く必要があります。
- 採用、雇用、オンボーディングのプロセスを文書化して、今後のプロジェクトに使用します。
（注: 技術ライターの候補者を募集したプロジェクトが、ケーススタディに記載されているとは限りません）。
技術ライターとの連携に関する一般的な問題
複数のプロジェクトのテクニカル ライターは、COVID-19 やその他の病気、またはパンデミックに関連する家族の責任のために、プロジェクトから離脱せざるを得ませんでした。一部のプロジェクトでは、タイムゾーンの不一致やインターネット接続の問題に関連するコミュニケーションの問題が報告されています。
プロジェクトは、コミュニティへのオンボーディングやプロジェクトのドキュメント ツールチェーンの設定に伴う難しさを過小評価していたことがわかりました。
一部のプロジェクトでは、Open Collective の銀行関連の問題や、ライターの居住国にお支払いに関する制限があるために、技術ライターへの支払いが遅延しました。
Open Collective の手数料に関するプログラムのドキュメントが明確ではありませんでした。Google は、プロジェクトへの最初の送金に対する Open Collective の取引手数料を負担しましたが、他の支払いチャネルによって課される取引手数料（通貨換算手数料など）は負担しませんでした。今後のプログラムについては、ドキュメントでこの点について明確に説明するようにします。
フォローアップ アンケート
ドキュメンタリー シーズン プログラムの一環として、プロジェクトにはフォローアップ アンケートへの参加が求められました。2022 年 5 月、8 月、11 月に 3 回調査を実施しました。
フォローアップ アンケートでは、提案書とケーススタディのリンクが引き続き有効であることを確認するようプロジェクトに依頼しました。また、プロジェクトの成功（事例で設定した指標に基づく）と、プロジェクトの技術ライターの継続的な参加と報酬に関する質問も含まれていました。
- Season of Docs の技術ライターと引き続き連携していますか？
- 技術ライターが引き続きプロジェクトに携わっている場合、なんらかの形で報酬を受け取っていますか？
- 現時点で、ドキュメント プロジェクトは成功していると思いますか？
今後の質問
いつものように、オープンソースのドキュメントについて学ぶほど、学びたいことが増えてきます。今後のシーズンでは、以下の点について学習していく予定です。
- プロジェクトのドメインがドキュメント タイプまたは指標の選択と相関しているかどうか
- プロジェクトの完了とテクニカル ライターの定着に最も効果的なテクニカル ライターの採用とオンボーディングの方法
- ドキュメントの効果を測定するための妥当なタイムライン
調査したい質問はたくさんありますが、ドキュメント シーズンに参加しているオープンソース プロジェクトの管理者とメンテナンス担当者の時間を尊重することも重要です。このプログラムの最優先事項は、ドキュメントに関する問題の解決をプロジェクトがサポートできるようにすることです。