本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- Tor Project
- 技術文件撰稿者：
- Swati Thacker
- 專案名稱：
- 重寫 Tor 手冊頁面
- 專案長度：
- 長時間放送 (5 個月)
Project description
在與 TOR 導師討論後，瞭解他們對這個專案的期望，我提出以下構想，為 TOR 手冊頁面 (https://2019.www.torproject.org/docs/tor-manual.html.en) 建立一致的結構和格式，讓使用者能快速參考。這項專案將在 3 個月內完成，下列提案會按月份細分。
第 1 個月：
建立這個頁面的目錄。目錄會包含總覽主題，以及所有 9 個設定選項類別的標題。這個月底前，使用者將能動動手指，輕鬆前往不同的設定類別。目錄會如下所示：
- 總覽：新增資訊，說明 TOR 在哪裡維護這些不同選項類別的設定 (如果這些選項都位於同一個位置)、設定檔的名稱和預設位置、使用指令選項的規則，以及使用者如何修改這些選項。(我們可以納入「設定檔格式」主題下方的介紹文字資訊)。
- 一般選項
- 用戶端選項
- 伺服器選項
- 目錄伺服器選項
- 測試網路選項
- 阻斷服務緩解選項
- 目錄授權伺服器選項
- 隱藏的服務選項
- 非永久性選項
第 2 個月：
手冊頁面的目的必須是快速回答有關各個選項功能和使用方式的問題。目前，選項不是以結構化格式記錄，每個選項的相關資訊都會分段顯示，因此使用者難以一眼就能找到資訊。所有關於選項的現有資訊都必須使用範本重新編排。本月底前，我們將提供一致的格式，用於記錄現有選項和未來的任何新選項。此外，這個格式可讓 TOR 手冊日後輕鬆用於「man」頁面。
- 首先，請為各個選項類別加入簡短說明，例如伺服器選項、用戶端選項等。這些說明可協助使用者瞭解各類別的選項。
- 建立範本，定義每個選項的一致格式。我建議在範本中加入下列區段/子區段。
- 名稱：要記錄的選項名稱。範例：BandwidthBurst
- Synopsis：選項的指令列語法的摘要。範例： BandwidthBurst N 個位元組
- Description： 說明設定選項的作用、預設值為何。 範例：使用此選項可將每個方向的權杖值區大小上限 (也稱為「Burt」) 限制套用到每個方向的特定位元組數。這個選項的預設值為 1 GB。
- 選項值：列出並說明選項允許的值。詳細說明每個值的功能，以及使用者應如何輸入值。
第 3 個月：
目前有 9 組/類別的設定選項。為提升搜尋功能並提供快速參考資料，請建立索引頁面，列出各個 9 個類別中的設定選項，並以字母順序排列。這些類別可依使用頻率排序，最常用的類別選項會排在最上方。
在這 3 個月結束後，我們就能製作整新品的 TOR 手冊，供使用者快速參考，以修改 TOR 中的配置設定。