Tor-Projekt

Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:

Tor-Projekt

Technischer Redakteur:

Swati Thacker

Projektname:

Das Tor-Handbuch neu schreiben

Projektdauer:

Langfristig (5 Monate)

Projektbeschreibung

Nach einem Gespräch mit den TOR-Mentoren, um ihre Erwartungen an dieses Projekt zu verstehen, schlage ich die folgenden Ideen vor, um eine einheitliche Struktur und ein einheitliches Format für die Seite zum TOR-Handbuch (https://2019.www.torproject.org/docs/tor-manual.html.en) zu schaffen und sie in eine nützliche Kurzreferenz für Nutzer zu verwandeln. Dieses Projekt wird in drei 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 eine Übersicht und Überschriften aller neun 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, sofern sich diese an einem Ort befinden, 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 dem Einleitungstext unter dem Thema KONFIGURATIONSDATEIFORMATE verwenden.)
• Allgemeine Optionen
• Clientoptionen
• Serveroptionen
• Optionen für Verzeichnisserver
• Netzwerkoptionen testen
• Optionen zur Minderung von DoS-Angriffen (Denial of Service)
• Directory Authority Server-Optionen
• Optionen für verborgene Dienste
• Nicht persistente Optionen

Hinweis: Derzeit enthält das TOR-Handbuch auch eine Reihe von Befehlszeilenoptionen. Aus Konsistenzgründen 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 und 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 zum Ende des Monats werden wir ein einheitliches Format für die Dokumentation bestehender und zukünftiger Optionen haben. Außerdem erleichtert dieses Format die Verwendung des TOR-Handbuchs in der Zukunft als Manpage.

• Fügen Sie zunächst eine kurze Beschreibung zu jeder Optionskategorie hinzu, z. B. Serveroptionen, Clientoptionen usw. Die Beschreibungen geben Aufschluss darüber, welche Optionen in den einzelnen Kategorien zu erwarten sind.
• 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 die Funktion der Konfigurationsoption und den Standardwert. Beispiel: Verwenden Sie diese Option, um die maximale Größe des Token-Buckets, auch als Busrt bezeichnet, auf eine bestimmte Anzahl von Byte in jeder Richtung zu beschränken. Die Standardeinstellung für diese Option ist 1 GB.
• Optionswert: Listet und beschreibt die Werte, die bei der Option zulässig sind. Beschreiben Sie im Detail, was jeder Wert bewirkt und wie der Nutzer die Werte eingeben soll.

Monat 3:

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

Nach Ablauf der drei Monate können wir ein generalüberholtes TOR-Handbuch vorlegen, das Nutzer als Schnellreferenz verwenden können, um die Konfigurationseinstellungen in TOR zu ändern.