本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 欧洲核子研究中心 (CERN-HSF)
- 技术文档工程师：
- LuckInTheRain
- 项目名称：
- ROOT 文档：分析、重构和重写
- 项目时长：
- 长期投放（5 个月）
Project description
该项目包括四个阶段：
1.) 分析当前的 ROOT 文档
我们根据以下标准对完整的 ROOT 文档（网站、用户指南、C++ 参考、教程等）进行分析和检查：结构化、模块化、标准化、访问机制、一致性、使用的信息类型、针对特定目标群体的准备和可理解性。目的是构建信息管理的概念、构建结构矩阵和内容标准化准则。
2.) 与 ROOT 团队定义用于构建软件文档编写方法的方法
我们向 ROOT 团队介绍了 OASIS 软件文档标准 DITA（达尔文信息输入架构，详见 https://www.oasis-open.org/committees/dita/）。重点是了解如何构建软件特定内容，以及如何使用“概念”“任务”和“参考”等基本信息类型来编写软件文档。
3.) 调整和重新整理 ROOT 文档
根据前两个步骤的结果，我们根据目标群组、角色和用例对 ROOT 文档进行了重组和模块化，并将内容分配给相应的元素（网站、用户指南、C++ 参考、教程等）和内容类型。由于所掌握的信息非常广泛，因此还必须建立一致的参考结构。目的是提供全面概览，并向用户明确说明如何使用 ROOT 来满足其需求。此外，还提供了非物理导向的紧凑型简介。
4.) 重写 ROOT 文档
本文档的主要部分（尤其是用户指南）已根据 DITA 方法进行了改写。结构指南和写作规则记录在风格指南中，以确保以后文档保持一致。目的是让 ROOT 团队将来能够自行扩展和维护 ROOT 文档。
预计时间安排（5 个月）：
第 1 阶段：分析当前的 ROOT 文档：3 周。
第 2 阶段：与 ROOT 团队一起定义构建软件文档编写方法的方法：2 周。
第 3 阶段：调整 ROOT 文档的结构和重新组织：4 周。
第 4 阶段：重写 ROOT 文档：11 周。