Diese Seite enthält die Details eines Projekts zum technischen Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Qubes OS
- Technischer Autor:
- luzeal
- Projektname:
- Onboard with QubesOS ! Let's write an open and easy-to-use guide
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Onboard with QubesOS !
Ich möchte einen offenen Leitfaden und zugehörige Materialien für neue QubesOS-Nutzer erstellen. Ziel ist es, QubesOS für Laien verständlich zu machen und den Leitfaden so kurz und verständlich wie möglich zu gestalten. Dazu sollen Analogien, Illustrationen und Diagramme verwendet werden. Um den Leitfaden kurz zu halten, werden Links zu zuverlässigen und vertrauenswürdigen Ressourcen verwendet, vor allem zu den Ressourcen auf der QubesOS-Website. Alle Inhalte werden unter einer Open-Source-Lizenz veröffentlicht.
Mit „eigenständig“ meine ich Inhalte, die unabhängig von der Website existieren könnten, z. B. als Handbuch. Das ist nicht dasselbe wie die Offlineversion 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 unter einer Open-Source-Lizenz veröffentlicht wird.
Mögliche Umsetzung
Zielgruppe definieren
Bisher habe ich den Eindruck, dass die Zielgruppe von QubesOS nicht gut definiert ist. Wie kann QubesOS Journalisten, Anwälten, Sicherheitsanalysten, Softwareentwicklern usw. helfen? Es wäre hilfreich, Szenarien zu beschreiben, in denen sich QubesOS als nützlich erweisen kann.
Erwartungen richtig setzen
Es wäre auch wichtig, neue Nutzer darauf hinzuweisen, dass QubesOS ein gewisses Maß an IT-Kenntnissen erfordert. Die Verwendung von QubesOS hat in Bezug auf die Nutzerfreundlichkeit ihren Preis, insbesondere wenn QubesOS das primäre Computersystem ist. Gleichzeitig gibt es Dinge, die QubesOS (absichtlich) nicht gut kann, z. B. 3D-Beschleunigung in virtuellen Maschinen. Es ist wichtig, das von Anfang an klarzustellen, nicht um Nutzer von der Verwendung abzuschrecken, sondern um die Erwartungen potenzieller Nutzer zu erfüllen.
Was QubesOS ist und was QubesOS nicht ist
Obwohl QubesOS ein besonderes Betriebssystem ist (eine Xen-Distribution), wäre es interessant, es mit anderen Betriebssystemen zu vergleichen, basierend auf ihren Funktionen oder dem Fehlen von Funktionen (z. B. verwendet Windows zunehmend Virtualisierung und Sandboxing als Sicherheitsmechanismen). Ein einfaches Diagramm oder eine Tabelle könnte verwendet werden.
Die Spezifikationen für den Leitfaden werden mit der Community definiert.
Welche Informationen muss der Leitfaden mindestens enthalten? Wie stark kann die Installation vereinfacht werden, ohne die Sicherheit zu beeinträchtigen? Wo sollte die Grenze liegen? Gibt es eine minimal funktionsfähige und sichere QubesOS-Einrichtung? Wenn nicht, könnte sie definiert und als Ziel für den Leitfaden festgelegt werden.
Lizenz
Wählen Sie eine Lizenz aus. Das angesehene Archlinux-Wiki verwendet die GNU Free Documentation License 1.3 oder höher. Wäre diese Lizenz geeignet?
Weitere Bemühungen
Website-Dokumentation optisch ansprechender gestalten
Hinweise könnten rot oder gelb hervorgehoben werden, um sie besser sichtbar zu machen. Beispielsweise könnten Farbfelder verwendet werden, wie sie im Archlinux-Wiki zu finden sind: https://wiki.archlinux.org/index.php/Linux_Containers.
Blockzitate könnten verwendet werden.
Inhalte verknüpfen
Derzeit gibt es viele Inhalte für die Dokumentationswebsite, aber die einzelnen Inhalte sind oft nicht mit anderen relevanten Themen verknüpft. Artikel könnten miteinander verknüpft werden, um die Auffindbarkeit zu verbessern.