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