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