本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Linux 基金会
- 技术文档工程师：
- xiaoya
- 项目名称：
- CHAOSS D&I 标记项目的构建文档
- 项目时长：
- 标准时长（3 个月）
Project description
我将主要内容放在以下位置：主要目标是丰富工作流中与文档相关的工作，编写面向社区的 D&I 标记文档，并在专用平台上托管经过多语言处理的文档，这些目标可分解为以下微任务：更新并集成当前的 PR 模板，以使用更多 D&I 指标并丰富问题。 起草一份概念概览，介绍 D&I 标记计划 使用 JOSS 文档起草申请者指南 使用 JOSS 文档起草审核员指南 一份文档，说明整个工作流程中的不同角色及其各自的责任。 一篇文档，说明如何将 GitHub Probot 应用于工作流； 一篇贡献者指南，说明新手如何为项目或文档做出贡献。帮助处理文档的翻译工作，检查自动翻译的效果（尤其是中文），并在必要时进行手动翻译。 根据翻译作品以多语言格式整理文档。 使用 Gitbook、Read the Doc 或 GitHub Wiki 托管文档。
交付成果 1. 通过更多指标和多样化问题，丰富项目和活动公关信息模板。 此交付项包括工作流程中的所有与文档相关的工作，尤其是为申请者准备的 PR 模板，我认为这是工作流程的核心组成部分，因为它在审核员评估中发挥着决定性作用，因此在整个工作流程的构建过程中，问题的形式和内容将不断完善，我将从以下几点来实现这一点： 根据不同类型的活动或项目 结合更多 D&I 指标 使用多种方式提出问题，并要求提供基于证据的回答
交付成果 2. 以下是面向社区的文档结构草稿
D&I 徽章概览
简介
目标
徽章等级
申请徽章
申请活动徽章
活动 PR 模板
申请项目徽章
项目 PR 模板
审核
如何成为审核员
D&I 徽章利益冲突政策
审核标准
审核核对清单
角色和责任
申请者 - 创建 PR
审核员 - 审核 PR
管理员 - 查看审核和审核分配
维护者 - 最终检查和 PR 合并
Probot
D&I 徽章行为准则
如何贡献
交付成果 3. 以多语言格式整理文档，并将其托管在 Read the docs 或 Gitbook 等平台上。
在当前工作流中，一些自动翻译工作正在研究中，我会帮助检查翻译结果（尤其是中文）的翻译结果，例如翻译的正确性和流畅性。 该文档将以某种格式存在，我将调查 Read the docs、Gitbook 和 GitHub wiki 等技术文档托管平台，并选择最适合托管面向开放社区的文档的平台。