本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- CERN-HSF
- 技術文件撰稿者：
- John
- 專案名稱：
- CERN-HSF - ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials
- 專案長度：
- 長時間跑步 (5 個月)
Project description
CERN-HSF - 適合一般大眾採用、動態 Python 繫結和教學課程的 ROOT 說明文件 Mentor：Olivier Couet、Axel Naumann
摘要：說明文件是讓使用者成功採用軟體的關鍵，清楚、正確且詳盡的使用者說明文件，有助於使用者在努力朝目標邁進的過程中，熟悉軟體。在以上幾行話下，明確的範例和教學都是強大的工具，讓使用者能快速學習。
我們在研究物理學家、研究人員和開發人員在物理學資料分析和可視化領域中使用 ROOT 的情況時，發現使用者友善且更新的說明文件具有許多好處。特別是由於原始碼的廣度和成長，說明文件系統會同時進行改良，讓使用者能充分運用 ROOT 提供的所有功能。
現行說明文件的摘要與分析 目前，使用者說明文件提供的操作指南，可讓物理學家更輕鬆地採用 ROOT，相較於一般使用者。此外，在特定主題 (例如動態 Python 繫結) 中，我們也能改善說明文件，讓說明更全面且清楚。同樣地，新的資料格式 RNTuple 缺少必要的詳細規格。最後，目前的說明文件缺少與 ROOT 7 相關的教學課程。
方法： 與 Olivier 討論後，我們認為為瞭解決上述問題，應著重於找出專業研究人員和一般使用者之間的知識差距，並建立相關說明文件來彌補這項差距，同時撰寫更詳細的動態 Python 繫結說明文件、為 ROOT 7 實作「現代分析教學課程」，以及為 RNTuple 建立詳細的技術規格。在這些環節中，說明文件可以結合 Jupyter 筆記本，為使用者提供實體、互動式學習工具。
時間表： 專案的階段預計如下： 找出專業研究人員和一般使用者之間的知識差距 (在閱讀目前的說明文件和原始程式碼時) → 1 至 2 週 建立和重構說明文件，以彌補這項差距 → 3 週 撰寫更詳細的 Dynamic Python Bindings 說明文件 → 3 週 實作 Dynamic Python Bindings 教學課程 → 3 週 實作 ROOT 7 教學課程 → 4 週 建立 RNTuple 的詳細技術規格 → 3 週 檢查專案目標是否已成功完成 → 1 週
交付項目與成功指南： 沒有任何缺口的整合式使用者說明文件 完整更新使用者說明文件，反映最新功能，例如透過 Jupyter 筆記本提供全新的衍生課程 教學課程