本頁針對 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 個位元組
- 說明： 說明設定選項的用途、預設值。範例：使用這個選項，將權杖值區大小上限 (也稱為「busrt」) 限制為各方向的指定位元組數。這個選項預設為 1 Gbyte。
- 選項值：列出並描述該選項允許的值。請詳細說明每個值的用途，以及使用者輸入值的方式。
第 3 個月：
目前設定選項分為 9 個群組/類別。為方便搜尋與快速參考，請建立索引頁面，列出 9 個類別中各個設定選項的字母順序排序。接著，這些類別可以按照使用的優先順序，將最常用的選項類別放在最上層。
3 個月後，我們就能製作一份整新品 TOR 手冊，方便使用者快速修改 TOR 中的配置設定。