本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- CERN-HSF
- 技術文件撰寫者：
- LuckInTheRain
- 專案名稱：
- ROOT 說明文件：分析、重組和重新編寫
- 專案長度：
- 長時間執行 (5 個月)
Project description
這項專案包含四個階段：
1.) 分析目前的 ROOT 說明文件
我們會根據以下條件分析及檢查完整的 ROOT 文件 (網站、使用指南、C++ 參考資料、教學課程等)：結構、模組化、標準化、存取機制、一致性、使用的資訊類型、目標群組專屬的準備工作與理解能力。目標是建立資訊管理的概念、架構的概念矩陣，以及內容標準化的準則。
2.) 與 ROOT 團隊定義撰寫軟體文件結構的方法
DITA (Darwin Information 輸入類型架構) 是 OASIS 軟體說明文件的 OASIS 標準 (https://www.oasis-open.org/committees/dita/) 供 ROOT 團隊使用。重點在於瞭解如何建構軟體專屬內容，以及如何使用「概念」、「任務」和「參考資料」等基礎資訊來撰寫軟體說明文件。
3.) 重組及重組 ROOT 說明文件
根據前兩個步驟的結果，ROOT 說明文件會根據目標群組、角色和用途，重新建構及模組化，並將內容指派給對應的元素 (網站、使用者指南、C++ 參考資料、教學課程等) 和內容類型。由於可用的資訊相當龐大，因此也必須建立一致的參考結構。目標在於提供全面的總覽，並向使用者清楚說明如何根據需求使用 ROOT。此外，我們也會提供適合非物理導向的簡短自我介紹。
4.) 重新編寫 ROOT 說明文件
說明文件的主要部分 (特別是《使用者指南》) 會根據 DITA 做法重新編寫。系統會將結構和寫作規則記錄在「樣式指南」中，以確保日後文件的一致性。目標是讓 ROOT 團隊日後能夠自行擴充及維護 ROOT 說明文件。
預估時間排程 (5 個月)：
第 1 階段：分析目前的 ROOT 說明文件：3 週。
第 2 階段：與 ROOT 團隊定義撰寫軟體說明文件的方法：2 週。
第 3 階段：重新建構及重整 ROOT 說明文件：4 週。
第 4 階段：重新撰寫 ROOT 說明文件：11 週。