Linux Foundation 專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織:
Linux 基礎
技術撰稿人:
xiaoya
專案名稱:
為 CHAOSS D&I 認證專案建立文件
專案長度:
標準長度 (3 個月)

Project description

我將主要內容放入以下部分: 主要目標是在工作流程中充實文件相關工作、編寫由社群適用的 D&I 徽章說明文件,並在專業平台中代管多語言處理文件,而該平台可分割為以下微任務: 更新目前的公關範本,藉此運用更多 D&I 指標和各種問題。 草擬概念概要,介紹 D&I 徽章計畫 草擬申請者規範,以 JOSS 文件做為參考 草擬審查者規範,以 JOSS 文件做為參考 說明整個工作流程中不同角色的職責。這份文件說明如何在工作流程中套用 GitHub 機器人。這份貢獻者指南說明新手如何為專案或文件貢獻內容。協助翻譯文件、檢查自動翻譯的品質 (特別是中文),並視需要進行手動翻譯。根據翻譯作業,以多語言格式整理說明文件。請使用 Gitbook、Read the Doc 或 GitHub Wiki 代管文件。

交付項目 1. 透過更多指標和多樣化的問題,豐富專案和事件公關稿範本。這項交付內容包括工作流程中的所有文件相關工作,尤其是針對申請者所準備完成的公關範本。我認為工作流程的核心元件在審查人員的評估過程中扮演重要角色,因此問題形式和內容會在工作流程的建構過程中得到完善,而我會從以下要點補充有關不同類型事件或專案的多元性指標:

交付項目 2. 以下是面向社群的文件草稿架構 D&I 徽章概略 介紹 目標 徽章等級 申請徽章 申請活動徽章 活動提交代碼審查要求範本 申請專案徽章
專案提交代碼審查要求範本 Probot D&I 徽章行為準則 如何貢獻

交付項目 3. 以多語言格式整理文件,並將文件託管在 Read the docs 或 Gitbook 等平台上。

在目前的工作流程中,我們正在研究一些自動翻譯作業,我會協助檢查翻譯結果的品質,尤其是中文翻譯的正確性和流暢度。這份文件採用的格式,我會調查技術文件代管平台,例如「閱讀說明文件」、「Gitbook」和「GitHub 維基」,然後選擇最適合的平台代管開放式社群文件。