本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- Tor Project
- 技術撰稿人：
- Swati Thack
- 專案名稱：
- 重新撰寫 Tor 手冊頁面
- 專案長度：
- 長期跑步 (5 個月)
Project description
與專家顧問討論過專案目標後，我提議透過以下想法，為「TOR 手冊」頁面 (https://2019.www.torproject.org/docs/tor-manual.html.en) 建立一致的結構和格式，方便使用者參考。這項專案將在 3 個月內完成，系統會按月細分下列提案。
第 1 個月：
為這個頁面建立目錄。TOC 包含總覽主題，以及所有 9 種設定選項的標題。本月月底前，使用者將能輕鬆透過手指前往不同的設定類別。TOC 看起來會像這樣：
- 總覽 – 提供資訊，說明 TOR 要在哪裡維護這些不同選項類別設定、是否集中存放設定、設定檔的名稱和預設位置、指令選項使用的規則，以及使用者如何修改這些選項。(我們可以加入「設定檔案格式」主題下方的簡介文字資訊)。
- 一般選項
- 客戶選項
- 伺服器選項
- 目錄伺服器選項
- 測試網路選項
- 阻斷服務因應措施
- 目錄授權伺服器選項
- 隱藏的服務選項
- 非持續性選項
第 2 個月：
手動頁面的目的在於迅速回答有關每個選項的功能和方式。目前並沒有以結構化格式記錄各種選項，而且每個選項的資訊都是以段落形式呈現，讓使用者一目瞭然。所有關於選項的現有資訊都必須使用範本重新整理。月底時，我們將提供一致的格式，方便您記錄現有的選項和日後推出的新選項。此外，這種格式還可方便日後將 TOR 手冊變為「man」頁面。
- 首先，請新增每個選項類別的簡短說明，例如「伺服器選項」、「用戶端選項」等。這類說明有助於使用者瞭解各類別分別提供哪些選項。
- 建立範本來定義統一格式的範本，以便記錄每個選項。建議您將下列區段/子區段加入範本中。
- 名稱：目前記錄的選項名稱。範例：BandwidthBurst
- 大綱：選項的指令列語法摘要。範例：BandwidthBurst N 個位元組
- 說明：說明設定選項的功能和預設值。範例：使用這個選項，將憑證區塊大小上限 (也稱為錯誤) 限制為每個方向的特定位元組數。這個選項的預設值為 1 Gbyte。
- 選項值：列出並說明該選項允許的值。詳細說明每個值的用途，以及使用者輸入值的方式。
第 3 個月：
設定選項目前共有 9 個群組/類別。您可以建立索引頁面，在 9 個類別中依字母順序列出設定選項，提升搜尋難度並快速參考參考資源。然後，這些類別可以依照其使用優先順序進行排序，最常用的選項類別會顯示在頂端。
3 個月試用期結束後，我們就能製作出整新的「TOR 手冊」，方便使用者快速參考並修改 TOR 中的組態設定。