本页详细介绍了 Google 文档季收录的技术文案项目。
项目摘要
- 开源组织：
- Kolibri
- 技术文档工程师：
- StephDix
- 项目名称：
- Kolibri 生态系统文档样式和工作流规范
- 项目时长：
- 长时间运行（5 个月）
Project description
摘要
本文档详细介绍了为 Learning Equality 记录的 Kolibri 生态系统项目记录信息的风格准则和工作流管理实现过程。
概览
我的方案分为四个阶段。在第一阶段，我将完成 LE 文档样式指南，并提供符合软件开发中的 LE 概念和样式准则的无障碍功能指南、文案和格式建议。在第二阶段，我将对 ReadTheDocs 和 GoogleDocs 文档执行质量审核。审核计划会整合使用核对清单来评估是否符合样式准则。这些核对清单将有助于记录发现结果并对文档应用更改。在第三阶段，我将着手处理 ReadTheDocs 和 Google 文档模板的结构、外观和风格。我将在 Google 云端硬盘中创建一个模板和图片库，其中包含主要文档类型的每个模板类别，以便在后续实现中重复使用。我将完成此任务，创建用于提交文档问题的模板，以便在拉取请求审核中轻松识别问题。 最后，我将创建一份贡献者指南，为每组协作者分组提供实用资源，以便他们更好地获取信息。
用途和范围
这项实施计划的目的是改善最终用户使用 Kolibri 文档的体验，并帮助团队成员和贡献者生成更好的文档，并积极在社区中进行协作。 此实现适用于 Kolibri 生态系统中的 ReadTheDocs 和 Google 文档的子集。
受众群体
主要受众群体是实现者、管理员和最终用户，他们是 Kolibri 文档最重要的使用者。 次要受众群体：团队成员和协作者，他们负责制作和使用 Kolibri 文档。
目标
Kolibri 生态系统文档的样式指南和工作流系统要求用户：使用简单易懂的语言和一致的布局构建易于理解的文档。在编写文档时，保留质量实践的维护。 保持文档渠道之间的信息便于访问。 加强 Kolibri 开源社区的协作计划。
信息来源
我的信息来源是 Kolibri、Kolibri Studio、Kolibri Development RTD 文档和 Google 云端硬盘中的 Kolibri 工具包。
出色的 Radina Matic 在提供热身活动和项目专用活动方面提供了很大帮助。她针对该组织对“指南”和“指南”的概念以及为贡献者提供的指南所做的贡献，帮助我整理了自己的想法和起草结论。
软件
我会在 Google 文档中起草样式指南。此文档平台非常适合在文档准备好发布时进行迭代。对于质量检查审核，我将使用 Google 表单进行文档审核和评估。电子表格将存储表单回复，以便进行文档控制。 我将使用 GitHub 重构 RTD 文档。我使用过 Git、Gitkraken、GitHub 和 Gitlab。我具备 Markdown 和一些 RestructuredText 的实际运用知识。我计划为文档修复做出贡献，以便继续学习语法。我会使用 ShareX 来处理图片和 GIF。我喜欢这个工具，因为它可以以不同的输出格式呈现。 我将使用“图表”工具绘制图表和编辑图片。Diagrams 软件可与 Google 文档、Google 云端硬盘和 LibreOffice 完美集成。 文档状态 在探索阶段，我修改了 Kolibri 的大部分文档。我发现大多数项目文档存在语法错误、拼写错误、布局、排版、图片使用不一致的问题，以及令人困惑的文档路径。例如，在 Kolibri 的用户指南中，“问题排查”部分是一个子主题，而不是一个主题。此信息恰好非常重要，最终用户需要能够通过目录访问它。第二种方法是，用户可以使用搜索栏和目录树展开其他主题并查找问题排查文章。
如需访问“问题排查”部分，您必须搜索该部分，或者展开“管理 Kolibri”，才能发现文档中包含“问题排查”部分。 指南与准则 对于此项目提案，我分析了以下两份文档：LE Kolibri 用户文档样式指南和 LE 翻译准则。在 LE Kolibri 指南中，我根据自己提议的主题大纲和文档计划，以及指南中需要改进的其他几点，提出了建议和意见。 对于 LE 翻译指南，我根据我的建议和风格指南中的现有惯例更改了格式和样式。 在分析过程中，我发现人们对归类为“指南”和“准则”的文档存在误解。
结果
除了使用初步表单提供建议和意见之外，我还对 LE 翻译指南进行了质量检查，具体详见质量检查任务。 以下是评估得出的最终评论： ICU Syntax .js 网站的链接已损坏 创建这些准则时所用的格式不正确。 本文档是指南，而非准则。 排版不一致。 标题和标题使用不当、语言使用不当和缩写词用错。替代文本使用不当。 重复的语句/ 指令过多。
两个文档的结果是此提案的应交付成果的一部分。
项目特定任务
- LE 用户文档样式指南建议（注释）
- 采用新样式和格式的 LE 翻译指南。
- 主题概要
- 项目时间表
- 文档任务