CERN-HSF 專案

本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。

專案摘要

開放原始碼機構：
CERN-HSF
技術文件撰寫者：
LuckInTheRain
專案名稱：
擴充及改善 ROOT 說明文件
專案長度：
長時間執行 (5 個月)

Project description

這項專案的目標是改善說明文件，而 ROOT 是全球高能量物理社群在資料分析和呈現資料的主要軟體系統。

除了我為專案提供的技術寫作技能之外，我也熟悉 ROOT (6 和 7) 的概念，並且瞭解專案所需的其他組成部分，例如：

  • C++
  • Python
  • Git/GitHub
  • 網站建構工具 (html、Markdown、Jkyll)

我在 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 中仍缺少的其他說明文件層面，