Tor-Projekt

Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:

Tor-Projekt

Technischer Redakteur:

Swati Thacker

Projektname:

Die TOR-Anleitungsseite umformulieren

Projektdauer:

Lange Ausführung (5 Monate)

Projektbeschreibung

Nach einem Gespräch mit den TOR-Mentoren, um zu erfahren, welche Erwartungen sie an das Projekt haben, schlage ich die folgenden Ideen vor, um eine einheitliche Struktur und ein einheitliches Format für die Seite des TOR-Handbuchs (https://2019.www.torproject.org/docs/tor-manual.html.en) zu schaffen, damit die Nutzer daraus eine nützliche Kurzanleitung erhalten. Dieses Projekt wird in 3 Monaten abgeschlossen und die folgenden Ideen sind nach Monat aufgeschlüsselt.

Monat 1:

Erstellen Sie ein Inhaltsverzeichnis für diese Seite. Das Inhaltsverzeichnis enthält ein Übersichtsthema und die Überschriften aller 9 Kategorien von Konfigurationsoptionen. Ab Ende dieses Monats können die Nutzer ganz einfach zu den verschiedenen Konfigurationskategorien navigieren. Das Inhaltsverzeichnis sieht so aus:

• Übersicht – Fügen Sie Informationen dazu hinzu, wo TOR die Konfiguration für diese verschiedenen Optionskategorien verwaltet (falls alle vorhanden sind), den Namen und den Standardspeicherort der Konfigurationsdatei, die Regeln für die Verwendung der Befehlsoptionen und wie Nutzer diese Optionen ändern können. (Wir können Informationen aus der Einleitung unter dem Thema KONFIGURATIONSDATEIFORMATE aufnehmen.)
• Allgemeine Optionen
• Clientoptionen
• Serveroptionen
• Optionen für Verzeichnisserver
• Netzwerkoptionen testen
• Optionen zur Minderung von DoS-Angriffen (Denial of Service)
• Optionen für Directory Authority-Server
• Ausgeblendete Dienstoptionen
• Nicht persistente Optionen

Hinweis: Derzeit enthält das TOR-Handbuch auch eine Reihe von Befehlszeilenoptionen. Aus Gründen der Einheitlichkeit und um den Schwerpunkt dieses Handbuchs auf Konfigurationsoptionen zu legen, denke ich, dass die Befehlszeilenoptionen von dieser Seite entfernt und als Referenz mit dieser Seite verknüpft werden können.

Monat 2:

Der Zweck der Seite muss darin bestehen, schnell Fragen zur Funktionsweise und Art der einzelnen Optionen zu beantworten. Derzeit sind die Optionen nicht in einem strukturierten Format dokumentiert. Informationen zu jeder Option werden in Absätzen dargestellt, wodurch es schwierig ist, Informationen auf einen Blick zu finden. Alle vorhandenen Informationen zu Optionen müssen mithilfe einer Vorlage neu organisiert werden. Bis Ende dieses Monats werden wir ein einheitliches Format für die Dokumentation bestehender Optionen und zukünftiger Optionen haben. Außerdem erleichtert dieses Format die Verwendung des TOR-Handbuchs in Zukunft als „Mann“-Seiten.

• Fügen Sie zunächst eine kurze Beschreibung zu jeder Optionskategorie hinzu, z. B. die Serveroptionen, die Clientoptionen usw. So wissen die Nutzer, welche Optionen sie in den einzelnen Kategorien erwarten können.
• Erstellen Sie eine Vorlage, um ein einheitliches Format für die Dokumentation jeder Option zu definieren. Ich schlage vor, die folgenden Abschnitte/Unterabschnitte in die Vorlage aufzunehmen.
• Name: Der Name der Option, die dokumentiert wird. Beispiel: BandwidthBurst
• Zusammenfassung: Die Zusammenfassung der Befehlszeilensyntax der Option. Beispiel: BandwidthBurst N Byte
• Beschreibung: Beschreiben Sie, was die Konfigurationsoption bewirkt und was der Standardwert ist. Beispiel: Verwenden Sie diese Option, um die maximale Größe des Token-Buckets, auch als Busrt bezeichnet, auf eine bestimmte Anzahl von Byte in jede Richtung zu beschränken. Die Standardeinstellung für diese Option ist 1 Gbyte.
• Optionswert: Liste und beschreibt die Werte, die die Option zulässt. Beschreiben Sie im Detail, was die einzelnen Werte bewirken und wie die Nutzenden die Werte eingeben sollen.

Monat 3:

Derzeit gibt es neun Gruppen/Kategorien für Konfigurationsoptionen. Erstellen Sie zur Verbesserung der Sichtbarkeit und als Schnellreferenz eine Indexseite, auf der Konfigurationsoptionen innerhalb der neun Kategorien alphabetisch sortiert sind. Diese Kategorien können dann nach der Priorität ihrer Nutzung sortiert werden, wobei die am häufigsten verwendeten Kategorien von Optionen ganz oben stehen.

Nach Ablauf der drei Monate können wir ein aufgearbeitetes TOR-Handbuch erstellen, anhand dessen Nutzer die Konfigurationseinstellungen in TOR als Kurzreferenz ändern können.