Diese Seite wurde von der Cloud Translation API übersetzt.

Qubes OS-Projekt

Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:: Qubes OS
Technischer Redakteur:: c1e0
Projektname:: Anleitungen zur Fehlerbehebung zusammenführen
Projektdauer:: Standardlänge (3 Monate)

Projektbeschreibung

ABSTRACT

Ein Leitfaden zur Fehlerbehebung soll Endnutzern helfen, Probleme bei der Verwendung eines Produkts oder Dienstes zu beheben. Eine gute Anleitung zur Fehlerbehebung ist wichtig, da sie Nutzern bei Problemen hilft. Es hindert Nutzende daran, ein Produkt zu verlassen, wenn ein Problem auftritt. Qubes hat täglich Tausende von Nutzern auf der ganzen Welt, von denen viele irgendwann auf ein Problem stoßen und von einem Leitfaden zur Fehlerbehebung profitieren werden.

AKTUELLER STATUS DES LEITFADEN ZUR FEHLERBEHEBUNG

Derzeit sind die QubesOS-Fehlerbehebungsleitfäden über viele Seiten verteilt und manchmal unvollständig. Daher wird immer wieder dieselbe Anleitung veröffentlicht, wenn Nutzern bei der Diagnose von Problemen geholfen wird. Die verfügbaren Leitfäden haben kein Symptom-Aktion-Layout, was es Nutzenden erschwert, ein Problem einer Lösung zuzuordnen. Darüber hinaus gibt es einige Probleme, die wiederholt in den sozialen Medien (Reddit), der Qubes GitHub-Problemseite und im #qubes-users Forum erwähnt wurden, aber nicht in der aktuellen Anleitung zur Fehlerbehebung dokumentiert sind.

Warum stellt mein vorgeschlagener Leitfaden zur Fehlerbehebung eine Verbesserung gegenüber dem aktuellen Leitfaden dar?

Mein vorgeschlagener Leitfaden zur Fehlerbehebung ist vollständig und strukturiert, um für Genauigkeit und einfache Navigation zu sorgen. Der Leitfaden enthält prägnante Anweisungen, die Schritt für Schritt erklären, wie ein Problem gelöst werden kann. Es hat ein Symptom-Aktion-Layout, in dem ein Problem beschrieben wird, gefolgt von einer empfohlenen Lösung zur Behebung dieses Problems. Die Fehlerbehebungen werden für Suchmaschinen optimiert und so formuliert, dass sie die Probleme berücksichtigen, nach denen Nutzer in sozialen Medien und Suchmaschinen suchen. So soll sichergestellt werden, dass Nutzer den offiziellen Leitfaden zur Fehlerbehebung über Suchmaschinen finden und schnell und einfach eine Lösung für ihre Probleme finden.

STRUKTUR DES VORGESEHENEN ANLEITUNGSANHANGS ZUR FEHLERBEHEBUNG UND ZEITPLAN

Ich habe eine vorgeschlagene Struktur für die Anleitung zur Fehlerbehebung unter Qubes OS erstellt, die Sie hier finden: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. Dem Layout ist ein geschätzter Zeitrahmen beigefügt, in dem die einzelnen Schritte zur Fehlerbehebung geschrieben werden. Dieses Layout wird nach dem Feedback des Mentors implementiert. Die Struktur und der Zeitrahmen können basierend auf dem Feedback der beratenden Person geändert werden.

PROJEKTZIELE

Strukturieren Sie den Leitfaden zur Fehlerbehebung neu, damit er ein verständlicheres, konsolidiertes Layout für Symptome und Maßnahmen hat.
Formulieren Sie vorhandene Fehlerbehebungen um, sodass sie leicht verständliche Schritt-für-Schritt-Anleitungen erhalten.
Füge bei Bedarf Screenshots hinzu
Qubes selbst installieren und ausprobieren und auftretende Probleme dokumentieren. Ich habe drei Computer: ein Lenovo Thinkpad, ein Dell Latitude und ein Acer Aspire. Ich werde Qubes auf jedem dieser Computer testen, alle Fehler aufzeichnen und alle Fehlerbehebungen validieren.
Entfernen Sie alle veralteten Informationen aus dem vorhandenen Leitfaden.
Prüfen Sie, ob die Schritte zur Fehlerbehebung korrekt sind. Derzeit enthalten die vorhandenen Anleitungen zur Fehlerbehebung die Fehlermeldung „Dies ist eine inoffizielle Dokumentation von Drittanbietern. Das Qubes OS-Projekt kann die Genauigkeit dieser Seite nicht garantieren. Bitte seien Sie vorsichtig.“ Diese Warnung wird entfernt, sobald die Anleitung zur Fehlerbehebung überprüft wurde. Die Richtigkeit wird entweder durch persönliche Tests der Fehlerbehebungen auf meinen PCs (falls möglich) oder durch Onlinerecherchen sichergestellt, um zu sehen, ob andere Nutzer die Lösung bestätigt haben.
Externe Fehlerbehebungen (aus dem Forum und GitHub) auf die offizielle Fehlerbehebungswebseite migrieren.
Weitere Probleme von Nutzern finden Sie auf Reddit (r/QubesOS), Stack Exchange, in der Google-Gruppe #qubes-users und in GitHub-Problemen. Ich werde auch Tools zur Keyword-Recherche wie Keywordtool.io und UberSuggest.com verwenden, um herauszufinden, nach welchen Fragen in Suchmaschinen wie Google häufig gesucht wird.
Fügen Sie einen Abschnitt „Hilfe erhalten“ hinzu, falls das Problem der Nutzer mithilfe des Leitfadens zur Fehlerbehebung nicht gelöst werden kann. 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 leidenschaftlich für Technologie, insbesondere für Internetsicherheit und Datenschutz. Ich glaube, dass das Schreiben eine meiner Stärken ist. Ich interessiere mich besonders für Qubes OS, weil es zwei meiner Hauptinteressen vereint: Sicherheit und Datenschutz. Ich bin ein begeisterter Nutzer anderer sicherheits- und datenschutzorientierter Produkte wie DuckDuckGo und Tor. Ich habe Qubes OS erst vor Kurzem entdeckt und bin bisher sehr zufrieden.

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

Ich interessiere mich für Sicherheit, Datenschutz und das Erstellen guter/hilfreicher Dokumentationen.
Da ich bei der Installation und Verwendung von Qubes OS Probleme festgestellt habe, kann ich diese Probleme in der Anleitung zur Fehlerbehebung besser darstellen.
Im letzten Monat habe ich mich mit den technischen Aspekten des Betriebssystems Qubes beschäftigt. Ich habe mir auch die Qubes-OS-Dokumentation ausführlich angesehen. Um ein Gefühl für den Prozess der Dokumentationsbearbeitung zu bekommen, habe ich einen Pull-Request erstellt (https://github.com/QubesOS/qubes-doc/pull/1005/files).
Ich habe vor Kurzem ein Praktikum beim Tor-Projekt absolviert. Ich habe im technischen Support und im Bereich Texterstellung gearbeitet. Während meiner Arbeit am Helpdesk erhielt ich Hunderte von Fragen von Nutzern, die Probleme bei der Installation oder Verwendung des Tor-Browsers hatten. Indem ich diesen Nutzern bei der Fehlerbehebung geholfen habe, habe ich gelernt, prägnante und verständliche Anleitungen zur Fehlerbehebung zu verfassen.
Während meiner Arbeit beim Tor Project habe ich auch technische Dokumentationen mit Markdown verfasst. Ich habe Git, GitHub und GitLab für die Versionskontrolle verwendet.