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:
- Luzeal
- Projektname:
- Einrichtung mit QubesOS Schreiben wir nun einen offenen und nutzerfreundlichen Leitfaden.
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Richten Sie QubesOS ein!
Ich möchte einen offenen Leitfaden und zugehörige Materialien für neue QubesOS-Nutzer erstellen. Ziel ist es, QubesOS einem Laien vorzustellen und den Leitfaden mithilfe von Analogien, Illustrationen und Diagrammen so klar und verständlich wie möglich zu halten. Links zu verlässlichen und vertrauenswürdigen Ressourcen werden verwendet, insbesondere zu denen, die auf der QubesOS-Website zu finden sind. Alles wird unter einer offenen Lizenz veröffentlicht.
Mit eigenständigen Inhalten meine ich Inhalte, die unabhängig von der Website existieren können, zum Beispiel als Handbuch. Sie entspricht nicht der Offline-Version des Leitfadens. Idealerweise wird neben der Website eine weitere Pipeline erstellt, um die Inhalte als Leitfaden zu veröffentlichen.
Mit „offen“ meine ich einen Leitfaden, der im Rahmen einer offenen Lizenz veröffentlicht wird.
Vorgehensweise
Zielgruppe definieren
Ich habe heute den Eindruck, dass die von QubesOS anvisierte Nutzerkategorie nicht genau definiert ist. Wie kann QubesOS Journalisten, Anwälte, Sicherheitsanalysten, Softwareentwickler und so weiter unterstützen? Es wäre aufschlussreich, Szenarien zu beschreiben, in denen sich QubeOS als nützlich erweisen kann.
Die richtigen Erwartungen definieren
Außerdem ist es wichtig, Erstnutzer darauf hinzuweisen, dass QubesOS ein gewisses Maß an IT-Kenntnissen erfordert. Die Nutzung von QubesOS ist im Hinblick auf die Nutzerfreundlichkeit kostenpflichtig, insbesondere wenn QubesOS Ihr primäres Computersystem ist. Es gibt aber auch Dinge, die QubeOS von Grund auf nicht gut anstellen kann, zum Beispiel die 3D-Beschleunigung in virtuellen Maschinen. Es ist wichtig, dies von Anfang an klar zu machen, nicht um Nutzer davon abzuhalten, es zu verwenden, sondern um Ausnahmen für potenzielle Nutzende festzulegen.
Was QubesOS ist und was QubesOS nicht ist
Obwohl QubesOS eine spezielle Generation von Betriebssystemen (eine Xen-Distribution) ist, wäre es interessant, es aufgrund ihrer Funktionalität oder des Fehlens mit anderen Betriebssystemen zu vergleichen. Windows nutzt z. B. zunehmend Virtualisierung und Sandboxing als Sicherheitsmechanismen. Ein einfaches Diagramm bzw. eine einfache Tabelle könnte verwendet werden.
Die Spezifikationen für den Guide werden mit der Community festgelegt.
Welche Informationen sollte der Leitfaden mindestens enthalten? Wie sehr kann die Installation ohne Kompromisse bei der Sicherheit vereinfacht werden? Wo sollte der Grenzwert liegen? Ist QubesOS so eingerichtet, dass es nur minimal realisierbar und sicher ist? Falls nicht, könnte er definiert und als Ziel für den Leitfaden festgelegt werden.
Lizenz
Hol dir eine Lizenz. Das angesehene Archlinux-Wiki verwendet die GNU Free Documentation License 1.3 oder höher. Wäre diese Lizenz geeignet?
Andere Anbieter
Websitedokumentation optisch ansprechender gestalten
Notizen können rot oder gelb markiert werden, damit sie leichter zu erkennen sind. Es könnten z. B. Farbfelder verwendet werden, wie sie im archlinux-Wiki unter https://wiki.archlinux.org/index.php/Linux_Containers zu finden sind.
Blockzitaten können verwendet werden.
Linkinhalte
Es gibt derzeit recht viele Inhalte für die Dokumentationswebsite, aber die einzelnen Teile sind oft nicht mit anderen relevanten Themen verknüpft. Artikel können miteinander verknüpft werden, um die Auffindbarkeit zu verbessern.