本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- CERN-HSF
- 技術文件撰寫者：
- 大明
- 專案名稱：
- CERN-HSF - 適用於一般目標對象採用、動態 Python 繫結和教學課程的 ROOT 說明文件
- 專案長度：
- 長時間執行 (5 個月)
Project description
CERN-HSF - 適用於一般目標對象採用、動態 Python 繫結與教學課程的 ROOT 說明文件 Mentor：Olivier Couet、Axel Naumann
摘要：如要讓使用者成功有效率地採用軟體，說明文件至關重要。清楚、準確且詳盡的使用者說明文件有助於使用者熟悉軟體，幫助他們達成目標。此外，清楚易懂的範例和教學課程也能做為功能強大的工具，讓使用者能快速上手。
在我們研究物理學家、研究人員和開發人員在物理分析與視覺化空間中使用 ROOT 的方式時，特別考量到容易使用且更新的說明文件。特別是，由於原始碼廣泛且其成長，說明文件系統具有優勢，在於藉由平行的演進獲得優勢，讓使用者能充分享有 ROOT 提供的所有功能。
目前說明文件的摘要與分析 目前，使用者可以參考使用者說明文件提供的指南，讓物理學家能以為一般大眾更輕鬆地採用 ROOT。此外，針對動態 Python 繫結等特定主題，我們可以進行改善，以便提供更完整且清楚的說明文件。同樣地，新的資料格式 RNTuple 也缺少必要的詳細規格。最後，目前的說明文件缺少與 ROOT 7 相關的教學課程。
方法： 與 Olivier 展開合作後，我們發現為瞭解決上述問題，主要重點應包括找出專業研究人員與一般目標對象之間的知識缺口、撰寫能夠彌補不足之處、撰寫更詳盡的動態 Python 繫結說明文件、為 ROOT 7 實作「現代分析教學課程」以及建立詳細的 TuRNple 技術規格。在這過程中，說明文件可能會整合 Jupyter 筆記本，因此能提供具體的互動式學習工具，協助使用者。
時程： 專案階段預計為： 專業研究人員與一般大眾之間的知識缺口 (同時閱讀目前的文件和原始碼) → 1 至 2 週 建立並重構說明文件，彌補不足之處 → 3 週 撰寫詳盡的 Dynamic Python Bindings → 3 週 針對動態 Python 繫結 Tuple 提交教學課程 → 3 週 針對動態 Python 繫結作業進行實作教學課程
成功的交付項目和指南： 單一的整合式使用者說明文件，且沒有任何落差 已完整更新使用者說明文件，反映最新的功能，例如：透過 Jupyter 筆記本使用新的衍生課程教學課程