本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Tor 项目
- 技术文档工程师：
- 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
- 摘要：选项的命令行语法的摘要。示例：BandwidthBurst N bytes
- 说明： 描述配置选项的用途以及默认值。 示例： 使用此选项可将每个方向的最大令牌桶大小（也称为 busrt）限制为给定的字节数。此选项的默认值为 1 千兆字节。
- 选项值：列出并说明该选项允许的值。详细说明每个值的用途以及用户应如何输入这些值。
第 3 个月：
目前，配置选项有 9 个组/类别。为了提高可搜索性并作为快速参考，请创建一个索引页，其中列出了按每个 9 个类别的字母顺序排列的配置选项。然后，您可以按使用优先级对这些类别进行排序，最常用的选项类别排在最前面。
3 个月后，我们可以生成翻新的 TOR 手册，供用户快速参考修改 TOR 中的配置设置。