CERN-HSF 项目

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

项目摘要

开源组织：

CERN-HSF

技术文档工程师：

John

项目名称：

CERN-HSF - ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials

项目时长：

长时间运行（5 个月）

Project description

CERN-HSF - 针对一般受众群体采用情况、动态 Python 绑定和教程的 ROOT 文档 导师：Olivier Couet、Axel Naumann

摘要：文档对于用户成功高效地采用软件至关重要。清晰、准确且全面的用户文档有助于用户在努力实现目标的过程中熟练掌握软件。与此同时，明确的示例和教程可作为强大的工具，帮助用户快速学习。

当我们研究物理学家、研究人员和开发者在物理数据分析和可视化领域对 ROOT 的使用时，认识到方便用户使用和更新后的文档的好处。特别是，由于源代码的广度及其增长，文档系统可以从并行发展中受益，使用户能够最大限度地利用 ROOT 提供的所有功能。

当前文档的摘要和分析 目前，用户文档提供了相关指南，让物理学家能够比一般受众更轻松地采用 ROOT。此外，在某些主题（例如动态 Python 绑定）中，我们可以进行改进，以便提供更全面、更清晰的文档。同样，新的数据格式 RNTuple 缺少必要的详细规范。最后，当前文档缺少与 ROOT 7 相关的教程。

方法：与 Olivier 协商后，我们发现，为了解决上述问题，主要工作应包括确定专业研究人员与一般受众群体之间的知识差距、创建文档以弥合这一差距、撰写有关动态 Python 绑定的更详细文档、为 ROOT 7 实现“现代分析教程”，以及为 RNTuple 创建详细的技术规范。在此过程中，文档中可以纳入 Jupyter 笔记本，这样切实可行的交互式学习工具就可以为用户提供帮助。

时间表： 该项目的各个阶段预计如下： 确定专业研究人员与一般受众群体之间的知识差距（在阅读当前文档和源代码时）→ 1-2 周 创建和重构文档以缩小差距 → 3 周 撰写更详细的动态 Python 绑定文档 → 3 周 实现动态 Python 绑定教程 → 3 周 实现 ROOT 7 教程 → 4 周 为 RNTuple 创建详细的技术规范 → 3 周 检查项目目标是否已成功完成 → 1 周

交付成果和成功指南： 统一的用户文档，没有任何空白 完全更新的用户文档，以反映最新功能，例如新的派生类 通过 Jupyter 笔记本提供的使用教程