本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Tor 项目
- 技术文档工程师：
- Swati Thacker
- 项目名称：
- 重写 Tor 手册页面
- 项目时长：
- 长期投放（5 个月）
Project description
在与 TOR 导师讨论了他们对这个项目的期望后，我提出了以下想法，希望可以为 TOR 手册页面 (https://2019.www.torproject.org/docs/tor-manual.html.en) 建立一致的结构和格式，以便用户快速参考。此项目将在 3 个月内完成，并且以下提示按月细分。
第 1 个月：
为此页面创建目录。目录包括一个概览主题，以及所有 9 类配置选项的标题。到本月底，用户将能够轻松浏览不同的配置类别。TOC 将如下所示：
- 概述 – 添加以下信息：TOR 在何处维护这些不同选项类别的配置，如果它们全都在同一位置，配置文件的名称和默认位置，使用命令选项的规则，以及用户如何修改这些选项。（我们可以在“配置文件格式”主题下添加介绍文字中的信息）。
- 常规选项
- 客户端选项
- 服务器选项
- 目录服务器选项
- 测试网络选项
- 拒绝服务攻击缓解选项
- 目录授权服务器选项
- 隐藏的服务选项
- 非永久性选项
第 2 个月：
手册页旨在快速解答各个选项功能及操作方式的问题。目前，选项不是以结构化格式记录，而且每个选项的相关信息都是以段落的形式呈现的，这使得用户很难一目了然地找到相应信息。所有关于选项的现有信息都需要使用模板进行重新整理。到本月底，我们将采用一致的格式记录现有方案，未来推出任何新方案。另外，此格式还可方便您日后将 TOR 手册用作“手册”页。
- 首先，添加有关每个选项类别的简短说明，如服务器选项、客户端选项等。通过这些说明，用户可以了解每个类别下会看到哪些选项。
- 创建一个模板，以便为记录每个选项定义一致的格式。我提议在模板中加入以下部分/子部分。
- 名称：正在记录的选项的名称。示例：BandwidthBurst
- 摘要：选项的命令行语法的摘要。示例：BandwidthBurst N 字节
- 说明：说明配置选项的作用、默认值是什么。示例：使用此选项可将令牌桶的最大大小（也称为 busrt）限制为每个方向的给定字节数。此选项默认为 1 GB。
- 选项值：列出并描述该选项允许的值。请详细说明每个值的用途，以及用户应如何输入值。
第 3 个月：
目前有 9 个配置选项组/类别。为了提高可搜索性并用作快速参考，请创建一个索引页面，其中列出 9 个类别中按字母顺序排序的配置选项。然后，可以按照使用优先级对这些类别进行排序，最常用的选项类别排在最上面。
3 个月期满后，我们可以制作翻新 TOR 手册，用户可使用该手册快速参考 TOR 中的配置设置。