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