Qubes OS-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:
Qubes OS
Technischer Redakteur:
c1e0
Projektname:
Anleitungen zur Fehlerbehebung konsolidieren
Projektdauer:
Standarddauer (3 Monate)

Projektbeschreibung

Abstrakt

Eine Anleitung zur Fehlerbehebung dient dazu, Endnutzer bei der Lösung von Problemen bei der Verwendung eines Produkts oder einer Dienstleistung zu unterstützen. Eine gute Anleitung zur Fehlerbehebung ist wichtig, da sie den Nutzenden bei Problemen hilft. So wird verhindert, dass Nutzende ein Produkt verlassen, wenn ein Problem auftritt. Qubes hat täglich Tausende von Nutzern auf der ganzen Welt, von denen viele irgendwann einmal ein Problem haben werden und von einer Anleitung zur Fehlerbehebung profitieren werden.

AKTUELLER STAND DER LEITFADEN ZUR FEHLERBEHEBUNG

Derzeit sind die QubesOS-Anleitungen zur Fehlerbehebung auf vielen Seiten verteilt und manchmal unvollständig. Dies führt dazu, dass Nutzer immer wieder dieselbe Anleitung posten, wenn sie bei der Problemdiagnose helfen. Den verfügbaren Anleitungen fehlt ein Symptom-Aktions-Layout, was es den Nutzenden erschwert, ein Problem der Lösung zuzuordnen. Darüber hinaus gibt es einige Probleme, die wiederholt in den sozialen Medien (Reddit), auf der Qubes GitHub-Problemseite und im #qubes-users Forum erwähnt wurden, aber nicht in der aktuellen Anleitung zur Fehlerbehebung dokumentiert wurden.

WARUM IST MEINE VORSCHLÄGE ZUR FEHLERBEHEBUNG EINE VERBESSERUNG ÜBER DEN AKTUELLEN ANLEITUNG?

Meine vorgeschlagene Anleitung zur Fehlerbehebung ist vollständig und strukturiert, um für Genauigkeit und einfache Navigation zu sorgen. Der Leitfaden enthält prägnante Anleitungen zur schrittweisen Lösung eines Problems. Sie enthält ein Symptom-Aktions-Layout, in dem ein Problem genannt wird, gefolgt von einer empfohlenen Lösung zur Lösung des Problems. Die Fehlerbehebungen werden suchmaschinenoptimiert und so formuliert, dass darin enthalten ist, welche Probleme Nutzer in sozialen Medien und Suchmaschinen suchen. All diese Maßnahmen tragen dazu bei, dass Nutzer die offizielle Anleitung zur Fehlerbehebung über Suchmaschinen finden und schnell und einfach die Lösung für ihre Probleme finden können.

STRUKTUR DES VORGESCHLAGENEN LEITFADEN ZUR FEHLERBEHEBUNG und ZEITRAUM

Ich habe einen Vorschlag für die Fehlerbehebung bei Qubes OS erstellt: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. Zum Layout gehört ein geschätzter Zeitraum, in dem die einzelnen Fehlerbehebungsabschnitte geschrieben werden. Dieses Layout wird nach dem Feedback des Mentors umgesetzt. Struktur und Zeitrahmen können je nach Feedback der beratenden Personen angepasst werden.

PROJEKTZIELE

  • Strukturieren Sie den Leitfaden zur Fehlerbehebung neu, um ein verständlicheres, konsolidiertes Layout für die Symptome zu erhalten.
  • Vorhandene Fehlerbehebungen umformulieren, sodass sie leicht verständliche Schritt-für-Schritt-Anleitungen enthalten.
  • Fügen Sie ggf. Screenshots hinzu.
  • Installieren und testen Sie Qubes selbst und notieren Sie etwaige Probleme. Ich habe drei Computer: ein Lenovo Thinkpad, Dell Latitude und ein Acer Aspire. Ich werde Qubes auf jedem dieser Computer ausprobieren, alle Fehler aufzeichnen und die Fehlerbehebung prüfen.
  • Entfernen Sie alle veralteten Informationen aus dem vorhandenen Leitfaden.
  • Prüfen Sie, ob die Fehlerbehebungen korrekt sind. Derzeit wird in den vorhandenen Anleitungen zur Fehlerbehebung die folgende Fehlermeldung angezeigt: "Dies ist eine inoffizielle Dokumentation von Drittanbietern. Das Qubes OS-Projekt kann die Richtigkeit dieser Seite nicht garantieren. Bitte sei vorsichtig.“ Diese Warnung wird verworfen, nachdem die Anweisungen zur Fehlerbehebung überprüft wurden. Die Fehlerfreiheit wird entweder durch persönliche Tests auf meinen PCs (falls möglich) oder durch Online-Überprüfung der Lösung sichergestellt.
  • Migrieren Sie alle externen Fehlerbehebungen (aus dem Forum und GitHub) zur offiziellen Webseite zur Fehlerbehebung.
  • Recherchieren und finden Sie weitere Probleme von Nutzern aus Reddit (r/QubesOS), Stack Exchange, der #qubes-users Google-Gruppe und GitHub. Ich werde auch Tools zur Keyword-Recherche wie Keywordtool.io und UberSuggest.com verwenden, um herauszufinden, welche Fragen in Suchmaschinen wie Google häufig gesucht werden.
  • Fügen Sie einen Abschnitt „Hilfe erhalten“ hinzu, falls die Anleitung zur Fehlerbehebung das Problem des Nutzers nicht löst. Ein Beispiel finden Sie auf der Seite zur Fehlerbehebung von Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help

WARUM DIESES PROJEKT?

Ich interessiere mich für Technologie, insbesondere für Internetsicherheit und Datenschutz. Ich glaube, dass Schreiben eine meiner Stärken ist. Ich interessiere mich besonders für Qubes OS, weil es zwei wichtige Interessen von mir überschneidet: Sicherheit und Datenschutz. Ich nutze gern andere Sicherheits- und Datenschutzprodukte wie DuckDuckGo und Tor. Ich habe Qubes OS erst vor Kurzem entdeckt und liebe es bisher.

WARUM ICH BIN FÜR DIE RICHTIGE PERSON FÜR DIESES PROJEKT BIN

  • Ich bin leidenschaftlich für Sicherheit, Datenschutz und gute/hilfreiche Dokumentationen.
  • Da bei der Installation und Verwendung von Qubes OS Probleme aufgetreten sind, kann ich diese Probleme in der Anleitung zur Fehlerbehebung besser darstellen.
  • Im vergangenen Monat habe ich mich mit den technischen Aspekten des Qubes-Betriebssystems beschäftigt. Außerdem habe ich die Dokumentation zu Qubes OS ausgiebig studiert. Um ein Gefühl für den Bearbeitungsprozess zu bekommen, habe ich eine Pull-Anfrage erstellt (https://github.com/QubesOS/qubes-doc/pull/1005/files).
  • Vor Kurzem habe ich ein Praktikum beim Tor-Projekt absolviert. Meine Aufgaben waren technischer Support und Schreiben. Während meiner Arbeit im Helpdesk erhielt ich hunderte von Fragen von Nutzern, die Probleme bei der Installation oder Verwendung des Tor-Browsers hatten. Indem ich diesen Nutzenden bei der Problemlösung geholfen habe, habe ich gelernt, prägnante und verständliche Anweisungen zur Fehlerbehebung zu verfassen.
  • Während meiner Arbeit beim Tor Project habe ich auch technische Dokumentationen mit Markdown geschrieben. Ich habe Git, GitHub und GitLab für die Versionsverwaltung verwendet.