本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 欧洲核子研究中心 (CERN-HSF)
- 技术文档工程师：
- 小明
- 项目名称：
- CERN-HSF - 有关通用受众群体采用、动态 Python 绑定和教程的 ROOT 文档
- 项目时长：
- 长期投放（5 个月）
Project description
CERN-HSF - 关于通用受众群体采用、动态 Python 绑定以及教程的根文档 导师：Olivier Couet、Axel Naumann
摘要：文档对于用户成功且高效地采用软件至关重要。清晰、准确且全面的用户文档有助于提升用户在努力实现目标的过程中熟练掌握软件的能力。在此过程中，明确的示例和教程是用户可快速学习的强大工具。
在我们审视物理学家、研究人员和开发者在物理数据分析和可视化领域对 ROOT 的使用时，我们已经认识到使用方便用户使用和及时更新文档的优势。特别是，由于源代码的广度及其发展，文档系统可从并行发展中受益，以便用户能够最大限度地利用 ROOT 提供的所有功能。
当前文档总结和分析 目前，用户文档提供了一个指南，物理学家可以比一般受众更轻松地采用 ROOT。此外，在某些主题（如动态 Python 绑定）中，还可以进行改进，以获得更全面、更清晰的文档。同样，新的数据格式 RNTuple 也缺少必要的详细规范。最后，当前的文档缺少与 ROOT 7 相关的教程。
方法： 与 Olivier 商讨后，似乎为了解决上述问题，主要的重点应该是识别专业研究人员和普通受众之间的知识缺口、创建文档来消除这一差距、编写更详细的动态 Python 绑定文档、为 ROOT 7 实现“现代分析教程”，以及为 RNTuple 制定详细的技术规范。在此过程中，文档可以整合 Jupyter 笔记本，以便有形的互动式学习工具为用户提供帮助。
时间表： 该项目预计分为以下阶段： 确定专业研究人员和一般受众之间的知识缺口（在阅读当前文档和源代码时）→ 1-2 周 创建和重构文档以弥合这一缺口 → 3 周 撰写更详细的动态 Python 绑定文档 → 3 周 成功实现关于动态 Python 绑定的规范 → 3 周完成学习 7 版本的 RO NT 教程 7 完成 3 周的 ROOT 教程
交付成果和成功指南： 统一用户文档，没有任何差异 全面更新的用户文档以反映最新功能，例如新的派生类 通过 Jupyter 笔记本提供教程