本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- HPX
- 技術文件撰稿者：
- rstobaugh
- 專案名稱：
- 編輯及簡化現有的 HPX 說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
我的提案是編輯及精簡現有 HPX 文件的內容。我建議進行標準期限 (三個月) 的專案，專注於修訂 STE||AR 群組手冊的兩個章節：「HPX 建構系統和啟動」(1) 和「設定 HPX 應用程式」(2)。
「HPX 建構系統和啟動」一章有幾個文法錯誤，也包含令人困惑的用語，以及「CMake」等字詞的不一致大小寫。此外，該章節還包含重複的資訊，我打算視需要重新排列、合併和刪除這些資訊。雖然「設定 HPX 應用程式」一章也包含一些需要解決的文法錯誤，但我對這一章的主要疑慮是其使用者友善性。本章節有三個主要設計問題，我打算解決這些問題：
有些標題暗藏在文字中，因此難以瀏覽不同章節。 目前，使用者必須仔細閱讀手冊，才能瞭解每個表格的用途。因此大多數使用者無法經由這個方式操作教學手冊，尤其是先前已經閱讀過內容的使用者。相反地，我打算確保每個表格都有清楚、獨特的標題，讓使用者在捲動文字時能輕鬆查看。
在特定標題下列出各種資源時，資源並未按照邏輯順序排列。雖然房源會依共同主題分組，但沒有子群組，因此資訊會顯得零散。舉例來說，使用者可能會遇到幾個處理地區性的資源、幾個處理其他主題的資源，以及一個處理地區性的資源。這種缺少標題的內部結構，會使更難找到特定主題的所有資訊。因此，我打算重新整理幾個圖表，以便在各標題下方更清楚地將類似資訊歸類。
使用者被迫來回瀏覽 (或在兩個不同的分頁中開啟手冊) 以全面瞭解特定指示。 在某些章節中，使用者會被導向前一個章節的某個句子，這會迫使讀者向上捲動或點選超連結，才能瞭解確切的操作說明，因為手冊使用了模糊的用語，例如「這個步驟是在前一個章節的步驟 11 之後執行」。雖然這個方法可以避免重複，但會使操作說明更難理解，因為必須依照特定順序排列這些工作。建議您改為加入更具體的措辭，讓使用者不必在各個部分或文件之間切換，中斷閱讀過程。
如果我能在標準時間表結束前完成這些部分，也想清理 STE||AR 群組「使用者文件」下的「Why HPX?」(3) 頁面。這個頁面包含重複的介紹內容，我希望能將這些內容整合，並且修正大小寫 (尤其是專業術語) 和語氣不一致的問題，以免給人分散感。我的目標是為 STE||AR 團隊的內容製作更統一、一致的介紹。