CERN-HSF 專案
本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。
專案摘要
- 開放原始碼組織：
- CERN-HSF
- 技術撰稿人：
- LuckInTheRain
- 專案名稱：
- 擴充及改善 ROOT 說明文件
- 專案長度：
- 長時間放送 (5 個月)
Project description
這個專案的目標是改善 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 手冊」) 需要在以下方面進行改善和補充：
預估時間表 (5 個月)：
- 第 1 階段：定義 ROOT 說明文件和教學課程的工作和範圍：2 週。
- 第 2 階段：從 ROOT 論壇收集及分析重要使用者問題：2 週
- 第 3 階段：編寫 ROOT 說明文件：8 週。
- 第 4 階段：開發教學課程：8 週
最後，我要補充說明，我已在去年透過長期的 Google 文件季專案，為 ROOT 文件做出貢獻。我定義了手冊的新結構。今年的提案可協助您完成 ROOT 中仍未填妥的其他說明文件資訊。
除非另有註明，否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間：2024-11-08 (世界標準時間)。
[null,null,["上次更新時間：2024-11-08 (世界標準時間)。"],[[["This project aims to improve and extend the documentation of ROOT, a data analysis software used by the high-energy physics community."],["The focus is on making the documentation more accessible to non-physicists, adding tutorials on core functionalities and new features like Python bindings and data mining tools."],["Key deliverables include technical specifications, tutorials on RDataFrame and RNtuple, and incorporating answers to frequently asked user questions."],["The project will be executed in phases, starting with defining the scope, analyzing user questions, writing documentation, and developing tutorials."],["The contributor has prior experience with ROOT and previously contributed to its documentation through Google Season of Docs."]]],["The project aims to enhance the ROOT documentation, a crucial tool for high-energy physics. Key actions include improving accessibility for non-physicists, developing new tutorials on general ROOT functionality, and documenting new features like Python bindings and data mining tools (RDataFrame, RNtuple). The project will also synthesize frequently asked questions from the ROOT forum into the documentation. A five-month timeline involves defining the documentation's scope, analyzing user questions, writing the documentation, and creating tutorials.\n"]]
