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 7 所提供功能的教程。

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

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

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

最后还要补充一点，我去年已经为一个长期的 Google 文档季项目贡献了 ROOT 文档。我定义了手册的新结构。 今年的提案将有助于完成 ROOT 中仍缺少的其他文档要素。