このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- 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 バッジについての概要
概要
目標
バッジのレベル
バッジを申請する
イベントバッジを申請する
イベント PR テンプレート
プロジェクト バッジに申し込む
プロジェクトの PR テンプレート
レビュー
レビュー担当者になる方法
D&I バッジ - 利益の衝突に関するポリシー
レビュー基準
レビューチェックリスト
役割と責任のレビュー
申請者へのレビュー
成果物 3. ドキュメントを多言語形式で整理し、「Read the docs」や「Gitbook」などのプラットフォームでホストします。
現在のワークフローでは、いくつかの自動翻訳作業を検討しています。特に中国語の翻訳結果が、翻訳の正確性や流暢さなどでどの程度適切に機能しているかを確認するお手伝いをさせていただきます。 ドキュメントはフォーマットとして存在します。ドキュメントを読む、Gitbook、GitHub の Wiki などの技術ドキュメント ホスティング プラットフォームを調査し、コミュニティ向けのオープンなドキュメントをホストするのに最適なプラットフォームを選択します。