現在のフェーズ:
ドキュメントの作成。タイムラインをご覧ください。
シーズン オブ ドキュメントは、Google オープンソース プログラム オフィスが管理するサステナビリティ プログラムです。「ドキュメント シーズン」の目標は次のとおりです。
- ドキュメントを使用してオープンソース プロジェクトをサポートし、プロジェクトの問題を解決する
- テクニカル ライターにオープンソースでの経験を積む機会を提供する
- オープンソース、ドキュメント、テクニカル ライティングの認知度を高める
- 効果的な指標に関する情報を収集してオープンソース ドキュメントに共有する
「ドキュメント シーズン」について詳しくは、プログラムのウェブサイトをご覧ください。
2022 年のプログラムの概要
「ドキュメントのシーズン」の仕組み
「ドキュメントのシーズン」では、組織はプロジェクト提案を提出することで申請します。プロジェクト提案書には以下が含まれます。
- 組織に関する情報
- プロジェクトが直面している問題の説明
- プロジェクトでドキュメントを使用して問題解決を支援する方法
- プロジェクトでドキュメントの有効性を測定する方法（指標）
- 作業のスケジュール
- プロジェクトの予算
- 追加情報（同様のプログラムでの組織の経験や、ドキュメント シーズンの管理者が自分のプロジェクトや問題を理解するのに役立つその他の情報）
プログラムへの参加が認められると、組織は自社のテクニカル ライターを直接採用して雇用します。シーズン オブ ドキュメントの資金提供には Open Collective が使用され、テクニカル ライターへの支払いは Open Collective を通じて行われます。プロジェクトの予算と支払いは透明性がある。予算は、「シーズン オブ ドキュメント」のサイトで入手できる組織のプロジェクト提案に含まれ、支払いは 「ドキュメント オープン コレクティブのシーズン」アカウントで確認できます。
事例紹介レポートを提出した組織は、このプログラムを修了したとみなされます。また、プログラムの期間中は月ごとの評価を実施し、プログラム完了後の 1 年間は四半期ごとに 3 回のフォローアップ アンケートの実施も求められます。
2022 年のハイライト
「新しい文書がリリースされた後、Casbin と Casdoor への 1 日あたりのアクセス数はほぼ倍増し、直帰率は約 30% 低下しました。」- Casbin
「このプロジェクトの喜ばしい成果は、[当社のテクニカル ライター] が私たちのコミュニティでリーダーの役割に成長するのを見てきました。両コントリビューターは現在、ワーキング グループやコミュニティのミーティングを主導するとともに、プロジェクトの設計とメンテナンスにも貢献しています。」 - moja-global
「[GSoD] のおかげで、通常の環境では非常に難しい有能なテクニカル ライターを 2 人採用することができました。彼らは、現在も OpenMined に積極的に OS のコントリビューターであり、素晴らしい仕事体験を得ています。」 - OpenMined
「また、この新しいマニュアルは計算質量分析の初心者にもずっと簡単になっています。具体的には、CZI の助成金は、これまで特権が足りない個人に給付金も支給しています。一部の受賞者は、新しい OpenMS マニュアルを使用して 6 週間のインターンシップ期間を開始し、新しいマニュアルに肯定的なレビューを行っています。」 - OpenMS
2022 年の概要データ
2022 年、シーズン オブ ドキュメント プログラムでは 67 件の応募の中から 31 件のプロジェクトを受け入れ、30 件のプロジェクトがプログラムを無事に完了しました。今回承認された 31 団体のうち、再申請は 17 団体でした。
承認された 31 件のプロジェクトには、58 人のテクニカル ライターが採用されました。190 人以上のテクニカル ライターが、このプログラムへの参加に興味を示していたため、シーズンの Google ドキュメントに関する GitHub リポジトリに連絡先情報とポートフォリオへのリンクを追加しました。
2022 年のプログラム:
- 100% の組織が申請プロセスに肯定的な経験がある
- 100% の組織がプログラムのウェブサイトのドキュメント/コンテンツを好意的に受け止めている
- 93% の組織がこのプログラムを好意的に経験している
- 90% の組織がドキュメント プロジェクトが成功したと感じている
組織について
「シーズン オブ ドキュメント 2022」に参加した組織は、さまざまなオープンソース プロジェクトを代表して参加しました。2022 年のコホートは次のとおりです。
- AsyncAPI や SpyderIDE などの開発ツール
- プログラミング言語とフレームワーク（Julia、LFortran、R、p5.js など）
- 科学プロジェクト（CERN-HSF、SymPy など）
- Mautic、Open Food Facts、Talawa、Ushahidi などのエンドユーザー アプリケーション
- ハードウェア プロジェクト、ロボット工学プロジェクト（ExpressLRS、Open-RMF など）
- データ プロジェクト（GeomScale、GeomStats、OpenMined、Weaviate など）
- クラウド プロジェクトとインフラストラクチャ プロジェクト（cert-manager、NimbleEdge、Cilium など）
プロジェクトに関するメタデータ（設立日、協力者の地理的分布、協力者の数、ユーザーベースの規模など）は収集していません。
どのオープンソース ライセンスを使用しているかを示すよう、プロジェクトにはお願いしていました。
ドキュメント プロジェクトについて
ドキュメントに関する問題
2022 年のプログラムで、組織がドキュメントによって解決したいと考えていた主な問題は次のとおりです。
ドキュメントに関する複数の問題が報告される場合もあります。詳しくは、シーズン オブ ドキュメント 2022 の結果ページをご覧ください。このページには、各組織の元のプロジェクト提案とケーススタディ全文へのリンクが掲載されています。
作成されたドキュメントの種類
ハウツーのドキュメントは、2022 年のケーススタディで最も多かったドキュメント タイプでした。
ケーススタディで取り上げたその他のドキュメント タイプ:
- クイックスタート
- 用語集
- よくある質問
- ナレッジベース
- コンポーネント
- ブログやソーシャル メディアのコンテンツ
- メンテナンス担当者向けガイド
これらのカテゴリの中にはあいまいなものもあり、1 つのドキュメント プロジェクトに複数のドキュメント タイプや機能が含まれていることもあります。
詳しくは、シーズン オブ ドキュメント 2022 の結果ページをご覧ください。このページには、各組織の元のプロジェクト提案とケーススタディ全文へのリンクが掲載されています。
予算
平均予算リクエストは $11,679、中央値は $12,150 でした。5 団体は、最も高額の補助金（15,000 ドル）を申請し、3 団体は最も低い補助金（5,000 ドル～ 7,000 ドル）を申請しました。
指標
ケーススタディでまとめたプロジェクトには、ドキュメント プロジェクトの成功を測定するために使用していた指標が示されています。
提案された上位の指標は次のとおりです。
他にも次のような指標が提案されています。
- pull リクエスト/コントリビューションに関するドキュメントの追加
- ドキュメント ページに関するより直接的なフィードバック
- ページ滞在時間
- 提起された問題（代替案）
- フォーラムの参加者
- パートナー/ボランティア/統合の数
- 直帰率の低下
- コミュニティでの認知度の向上。
テクニカル ライティング プロジェクトの完了からケーススタディの提出までの期間が短いため、2022 年のほとんどのコホートは、ケーススタディの提出時点では、最初の指標を満たしているかどうかを判断するのに十分なデータを収集できませんでした。
2023 年にフォローアップ アンケートへの回答が得られ次第、このレポートを更新し、どのプロジェクトがその指標を達成または修正したかについての情報を追加する予定です。
詳しくは、シーズン オブ ドキュメント 2022 の結果ページをご覧ください。このページには、各組織の元のプロジェクト提案とケーススタディ全文へのリンクが掲載されています。
テクニカル ライターとの連携
「ドキュメント シーズン」プログラムでは、プロジェクトでテクニカル ライターの採用、面接、採用、および直接の報酬が期待されます。テクニカル ライターは、Google の GitHub リポジトリにある Google ドキュメント シーズンが管理しているディレクトリに自身を追加できますが、シーズン ドキュメントのスタッフがテクニカル ライターを調査または推奨することはありません。
オープンソース プロジェクトのテクニカル ライターの採用に関するベスト プラクティス
各プロジェクトでは、テクニカル ライターの採用、採用、協力に関するベスト プラクティスを共有するよう依頼されました。上位の推奨事項は次のとおりです。
人材サービス
- 履歴書を確認するだけでなく、少数の候補者にインタビューし、ライブの練習セッションを使用する
- プロジェクトの言語やツールの習熟度よりも、文書と口頭でのコミュニケーション スキルを重視します。
- テクニカル ライターがプロジェクトの作業に必要な専門知識をどのように習得するかについて、直接質問する
- プロジェクトのミッションに熱意を持ち、コアなオープンソース価値を共有している人は、プロジェクト全体を通してモチベーションを維持してくれる可能性が高くなります。
- 考え方やバックグラウンドが多岐にわたるプロジェクトはプロジェクトに役立つため、世界中の応募者を受け入れるようにしましょう。ただし、あまりにも多くのタイムゾーンでライターやメンターがいると、良好なコミュニケーションを維持するために多大な労力が必要になる可能性があることに留意してください
採用
- 成果物、支払いスケジュール、具体的な期限が明記された契約を使用します
- プロジェクトに不明点が多い場合は、ドキュメント作成とは別に発見または調査のマイルストーンを含めます。
調整とコミュニケーション
- 会議をログに記録して決定事項を記録し、プロジェクトに携わる全員がコンテキストと次のステップを簡単に把握できるようにする
- 週 1 回の電話連絡、毎日 1 通のメール、チャット チャネルのステータス更新など、どのようなコミュニケーションが期待されるかとその頻度を明確にする
- 迅速に返答し、「何が」だけでなく「なぜ」を含め、明確なフィードバックを提供する
- テクニカル ライターを幅広いコミュニティとつなげてコンテキストを提供し、作品を周知します
プロセスとツール
- 「ドキュメントのシーズン後も継続し、コミュニティ全体が貢献できるドキュメント プロセスを作成する」
- ドキュメント レビューは少なくともコードレビューと同程度に時間がかかり、同じくらい集中的です。十分に時間をかけてください。
わかりやすくするため、一部の推奨事項は編集および要約されています。
2021 年のプログラムと同様に、シーズン オブ ドキュメント 2022 でも、ほとんどのテクニカル ライターが協働した組織に直接応募しました。
テクニカル ライターとの作業でよくある問題
2022 年のプログラムで、テクニカル ライターとの連携に関する問題が報告されたプロジェクトは減少しました。テクニカル ライターがプログラムを完了できないことが最大の問題でした。原因は、病気、フルタイムの仕事、時間の確保などが原因です。
あるプロジェクトでは、ドキュメント プロジェクトが Google Summer of Code の一環として行われる作業に依存しており、それらの依存関係の管理が難しいと報告されました。別のプロジェクトでは、テクニカル ライターが文書化する必要があるハードウェアが、ライターの国の国防省に没収され、インポートできないという問題に直面しました。
フォローアップ アンケート
2023 年 5 月、8 月、11 月に、2022 年の参加者に 3 回のフォローアップ アンケートが送信されます。結果が出たら、このセクションを更新し、
今後の質問
いつものように、オープンソースのドキュメントについて学べば学ぶほど、学びも増えます。
今後のシーズンでは、以下のことを目標としています。
- より多くのプロジェクト メタデータを収集し、プロジェクトの経過時間、コミュニティの規模、言語とドキュメントのニーズとの相関関係を探す
- ドキュメント プロジェクトを分析して、共有可能なテンプレートに一般化できるかどうかを確認する
- オープンソース プロジェクトのテクニカル ライターにインタビューするためのルーブリックを作成する
調査したい質問は多数ありますが、シーズン オブ ドキュメントのオープンソース プロジェクト管理者やメンテナンス担当者のお時間を無駄にしないためにも、ご協力のほどお願い申し上げます。このプログラムの最優先事項は、プロジェクトがドキュメントによって問題を解決できるようサポートすることです。