CERN-HSF 项目

本页详细介绍了 Google 文档季收录的技术文案项目。

项目摘要

开源组织：
CERN-HSF
技术文档工程师：
LuckInTheRain
项目名称：
扩展和改进 ROOT 文档
项目时长：
长时间运行（5 个月）

Project description

本项目的目标是改进 ROOT 的文档。ROOT 是全球高能物理学社区使用的数据分析和数据演示主要软件系统。

除了我可以为项目提供技术文档写作技能之外，我也熟悉 ROOT（6 和 7），并且了解项目所需的其他要素，例如：

  • C++
  • Python
  • Git/GitHub
  • 网站构建工具（HTML、Markdown、Jekyll）

我在 ROOT 文档中找到了三个主要部分：

  • 网站 https://root.cern，
  • C++ 类参考指南 https://root.cern/doc/master/，
  • 论坛 https://root-forum.cern.ch

在我看来，ROOT 文档（新的“ROOT 手册”）在以下方面需要改进和补充：

  • 非物理学家应该能更轻松地阅读和理解本书，尤其是前几章。
  • 我们将开发更多介绍 ROOT 常规功能的教程。
  • 应添加一些新主题和新进展，并附上详细说明和示例。 其中包括：
    • Python 绑定
    • 数学库
    • 高级图形工具（TRatioPLot、THStack）的手册说明
    • 新的数据挖掘分析工具 (RDataFrame 和 RNtuple)
  • 新键数据格式（RDataFrame 和 RNtuple）需要详细的技术规范和教程。

  • 文档中需要包含对用户提出的重要问题的解答，例如 ROOT 论坛中发布的问题。这需要对最常见的问题进行细致分析，然后进行综合整理，将其转化为新版“ROOT 手册”或参考指南中的一些新教程中的文档内容。

  • 说明 ROOT 7 所提供功能的教程。

    • 新的 ROOT 7 直方图
    • 新的 ROOT 7 图形

预计时间安排（5 个月）：

  • 第 1 阶段：定义 ROOT 文档和教程的任务和范围：2 周。
  • 第 2 阶段：从 ROOT 论坛收集和分析重要用户问题：2 周
  • 第 3 阶段：编写 ROOT 文档：8 周。
  • 第 4 阶段：开发教程：8 周

最后，我应该补充一点，我去年就参与了 Google 长期性文档季项目，为 ROOT 文档做出了贡献。我定义了手册的新结构。 今年的提案将有助于完成 ROOT 中仍缺少的其他文档方面。