CERN-HSF 项目

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

项目摘要

开源组织：

CERN-HSF

技术文档工程师：

LuckInTheRain

项目名称：

ROOT 文档：分析、重构和重写

项目时长：

长时间运行（5 个月）

Project description

该项目包含以下四个阶段：

1.) 分析当前的 ROOT 文档

我们会根据以下标准分析和检查完整的 ROOT 文档（网站、用户指南、C++ 参考文档、教程等）：结构化、模块化、标准化、访问机制、一致性、使用的信息类型、针对特定目标组的准备和理解性。目的是创建信息管理概念、结构化矩阵和内容标准化准则。

2.) 与 ROOT 团队一起定义编写软件文档的结构方法

向 ROOT 团队介绍了 DITA（Darwin 信息分类架构），这是一种软件文档 OASIS 标准 (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 周。