Linux Foundation 项目

本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。

项目摘要

开源组织:
Linux 基金会
技术文档工程师:
小雅
项目名称:
为 CHAOSS D&I 标志项目构建文档
项目时长:
标准时长(3 个月)

Project description

主要内容如下: 主要目标是丰富工作流程中的文档相关作品,编写面向社区的 D&I 标记文档,并在专业平台上托管多语言处理文档,这些文档可分为以下微小任务: 更新和集成当前的 PR 模板,以采用更多 D&I 指标和多样化的问题。 起草一份概念性概览以介绍 D&I 徽章计划 以 JOSS 文档为参考,起草审核人员准则 将 JOSS 文档作为参考起草审核人员准则 该文档说明了整个工作流程中的不同角色和各自的职责。 说明 GitHub Probot 如何应用于工作流的文档。贡献者指南,说明新人如何贡献项目或文档。帮助文档翻译工作,检查自动翻译的效果(尤其是中文),并根据需要进行手动翻译。 根据翻译作品以多语言格式整理文档。 使用 Gitbook、阅读文档或 GitHub Wiki 托管文档。

交付成果 1. 通过更多指标和多样化的问题丰富项目和活动公关模板。 交付成果包括工作流程中所有与文件相关的工作,特别是为申请者准备的 PR 模板。我认为这是该工作流程的核心组成部分,因为它在审核人员评估中起着决定性的作用,因此问题的形式和内容将在整个工作流程的构建过程中完善,我将从以下方面提供这些工作: 基于不同类型的事件或项目

交付成果 2. 以下是面向社区的文档结构草稿 D&I 徽章概览 简介 目标 徽章级别 申请徽章 申请活动徽章 活动 PR 模板 申请项目徽章
项目 PR 模板 审核 如何成为审核者 D&I 徽章 利益冲突政策 审核标准 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 审核人员 - 申请者 - 申请徽章

交付成果 3. 以多语言格式整理文档,并将其托管在“阅读文档”或 Gitbook 等平台上。

在当前工作流程中,我们正在探索一些自动翻译作品,我将帮助检查翻译结果(尤其是中文的翻译结果)的正确性和流利程度。 文档将以格式形式存在,我会研究技术文档托管平台(如阅读文档、Gitbook 和 GitHub wiki),并选择最合适的平台来托管面向开放社区的文档。