このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソースの組織:
- The Linux Foundation
- テクニカル ライター:
- xiaoya
- プロジェクト名:
- CHAOSS D&I バッジ プロジェクトのドキュメントを作成
- プロジェクト期間:
- 標準期間（3 か月）
プロジェクトの説明
主な内容は次のとおりです。主な目標は、ワークフロー内のドキュメント関連の作業を充実させ、コミュニティ向けの D&I バッジのドキュメントを作成し、多言語で処理されたドキュメントを専門のプラットフォームでホストすることです。これは、次のマイクロタスクに分割できます。現在の PR テンプレートを更新して統合し、より多くの D&I 指標を使用して質問を多様化します。D&I バッジ プログラムを紹介する概念的な概要の下書きを作成します。Joss のドキュメントを参照して申請者のガイドラインの下書きを作成します。Joss のドキュメントを参照して審査担当者のガイドラインの下書きを作成します。ワークフローのさまざまな役割とそれぞれの責任を説明するドキュメント。GitHub probot がワークフローに適用される仕組みを説明するドキュメント。新規ユーザーがプロジェクトまたはドキュメントにどのように貢献できるかを示すコントリビューター ガイドライン。ドキュメントの翻訳作業を支援し、特に中国語の自動翻訳のパフォーマンスを確認し、必要に応じて手動翻訳作業を行います。翻訳作業に基づいて、ドキュメントを複数の言語の形式で整理します。Gitbook、Read the Doc、GitHub Wiki を使用してドキュメントをホストします。
成果物 1. プロジェクトとイベントの PR テンプレートを拡充し、より多くの指標と多様な質問を追加します。この成果物には、ワークフロー内のドキュメント関連の作業がすべて含まれています。特に、応募者が記入する準備ができた PR テンプレートは、審査担当者の評価において決定的な役割を果たすため、ワークフローのコア コンポーネントだと思います。そのため、質問の形式と内容はワークフローの構築全体を通じて完成します。この点から、以下の点からこれを提供します。 さまざまなタイプのイベントやプロジェクトの回答に基づいて、より多様性に富む質問と、より多様性に富んだ回答を、より必要とする回答と指標と組み合わせる
成果物 2. コミュニティ向けのドキュメントのドラフト構造のドラフトを次に示します。
ドラフトのコミュニティ向けドキュメント構造のドラフトあり
D&I バッジのレビュー
最終レビュー バッジのレビュー
成果物 3. ドキュメントを複数の言語の形式で整理し、Read the Docs や Gitbook などのプラットフォームでホストします。
現在のワークフローで、自動翻訳の一部が検討されています。私は、翻訳の正確性や流暢性など、特に中国語での翻訳結果の品質を確認するサポートを担当します。ドキュメントは 1 つの形式として存在します。技術ドキュメントをホストするプラットフォーム（Read the docs、Gitbook、GitHub wiki など）を調査し、オープンなコミュニティ向けドキュメントをホストするのに最適なプラットフォームを選択します。