本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- 歐洲核子研究組織 (CERN-HSF)
- 技術撰稿人：
- John
- 專案名稱：
- CERN-HSF - 適用於一般目標對象採用情形的 ROOT 說明文件、動態 Python 繫結和教學課程
- 專案長度：
- 長期跑步 (5 個月)
Project description
CERN-HSF - 適用於一般目標對象採用、動態 Python 繫結和教學課程的 ROOT 說明文件 導師：Olivier Couet、Axel Naumann
摘要：如要讓使用者成功採用軟體，說明文件是不可或缺的一環。清楚、正確且全面的使用者文件可協助使用者熟悉軟體，協助他們達成目標。此外，使用者也能藉由明確的範例和教學，迅速瞭解各種實用工具。
在資料分析和物理視覺化空間中，我們確認物理學家、研究人員和開發人員在資料分析和視覺化空間中使用 ROOT 的應用時，可發現容易理解且更新文件的優點。尤其是，由於原始碼的廣度和擴充發展，說明文件系統必須受益於平行改進技術，以便使用者充分運用 ROOT 提供的所有功能。
目前說明文件的摘要與分析 目前，使用者說明文件提供指南，可讓物理學家比一般大眾更容易採用 ROOT。此外，某些主題 (例如動態 Python 繫結) 也可以改善對於更完整清楚的說明文件。同樣地，新的資料格式 RNTuple 也缺乏必要的詳細規格。最後，目前的說明文件缺少有關 ROOT 7 的教學課程。
方法： 與 Olivier 溝通之後，我們發現為瞭解決上述問題，主要重點應包括找出專業研究人員和一般大眾之間的知識差距、建立文件來彌平缺口、為 ROOT 7 實作「現代分析教學教學課程」，以及為 RNTuple 建立「現代分析教學課程」。同時，在這些階段，說明文件可能會整合 Jupyter 筆記本，以提供實質的互動式學習工具協助使用者。
時程： 預估完成專案的階段 3 週 - 完成專案階段 3 週 - 找出專業研究人員和一般目標對象之間的知識差距 (閱讀目前的文件和原始碼時) → 建立及重構說明文件，藉此填補缺口 → 3 週 撰寫更詳細的動態 Python 繫結教學課程 → 3 星期 實作
成功交付項目與指南： 單一統合式使用者說明文件，不含任何缺口 已更新使用者說明文件，以反映最新功能，例如透過 Jupyter 筆記本提供的全新衍生類別教學課程