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 手冊」) 需要在以下方面進行改善和補充：

  • 這本書應該會更容易讓非物理學家閱讀，尤其是前幾章。
  • 建議製作更多教學課程，說明 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 中仍未填妥的其他說明文件資訊。