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:
- Das FreeBSD-Projekt
- Technischer Redakteur:
- quaffeine
- Projektname:
- Kapitel für das Weinhandbuch erstellen
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Im Rahmen dieser Initiative würde ich ein ausführliches Kapitel im FreeBSD-Handbuch zur Installation, Verwendung und Fehlerbehebung von WINE (www.winehq.org) unter FreeBSD verfassen. Sofern nicht anders angegeben, würde ich versuchen, jede Woche 4 bis 8 Stunden an den folgenden Punkten zu arbeiten.
*** Community-Bindung
Wenn ich ausgewählt werde, würde ich mich während des Community-Bonding-Zeitraums mit den Dokumentationsprozessen und der Infrastruktur des FreeBSD-Projekts vertraut machen. Ich war immer beeindruckt von der einheitlichen Dokumentation, die im Rahmen des Projekts veröffentlicht wurde, und würde mich mit den Teammitgliedern des Projekts über ihren Workflow austauschen. Außerdem würde ich in nutzerorientierten Foren nachlesen, was FreeBSD-Nutzern in Bezug auf die Dokumentation im Allgemeinen und die Arbeit mit WINE unter FreeBSD im Besonderen helfen würde.
Während dieser Zeit würde ich die Dokumentations-Toolchain des Projekts kennenlernen. So kann ich in den ersten Wochen des Projekts direkt loslegen, wenn ich ausgewählt werde.
*** Woche 1 (14.–19. September): Installationen testen und Fehler beheben
In der ersten Woche der Dokumententwicklungsphase würde ich eine Installation von WINE in der aktuellen stabilen Version von FreeBSD als Trockenlauf durchführen und eine Vielzahl von Windows-Anwendungen installieren und ausführen, von einfachen Dienstprogrammen bis hin zu komplexeren Anwendungen. Dieser Ansatz wurde in einem ähnlichen Artikel über ReactOS für MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/) verwendet. Ich würde jedoch die erste Woche nutzen, um eine größere Auswahl an Programmen zu untersuchen.
Meiner Erfahrung nach ist es hilfreich, im Voraus Zeit zu investieren, um allgemeine Probleme zu identifizieren und zu beheben. So habe ich die Lösungen zur Hand, wenn es an der Zeit ist, die relevanten Abschnitte zu schreiben, oder kann zumindest an die entsprechenden Stellen um Hilfe bitten.
Ziel der Woche:Sie erhalten einen Überblick über die Installationskapitel und die erforderlichen Details zur Behebung häufiger Installationsprobleme.
*** Woche 2 (21.–25. September): WINE-Installation dokumentieren
In Woche 2 würde ich die Abschnitte entwerfen, in denen die Installation von WINE über gängige Methoden veranschaulicht wird, darunter:
- Über das Portsystem von der Quelle
- Über Binärpakete mit Kern-Repositories
- Verwenden Sie verfügbare GUI-Paketmanager, falls verfügbar.
- Aus alternativen Repositories wie FreshPorts (und warum ein Nutzer dies tun möchte)
In diesem Abschnitt werden 32-Bit- und 64-Bit-Installationen sowie gleichzeitige Installationen verglichen, um die zusätzlichen Schritte hervorzuheben, die für das Ausführen von Programmen mit unterschiedlichen Architekturen erforderlich sind.
Ziel der Woche:Eine ausgearbeitete Entwurfsversion der Abschnitte, in denen die Installation von WINE unter FreeBSD beschrieben wird. Dieser „ausgefeilte Entwurf“ sollte einen nahezu fertigen Text (vorbehaltlich Korrekturlesen und Feedback) und Platzhalter für Screenshots enthalten, wenn nicht die Screenshots selbst.
*** Woche 3 (28. September bis 2. Oktober): Erstes WINE-Programm unter FreeBSD ausführen
Nachdem das WINE-Subsystem installiert ist, wird im nächsten Abschnitt die Installation und Ausführung einiger erster Programme beschrieben. Diese konzentrieren sich höchstwahrscheinlich auf einfache, eigenständige Dienstprogramme wie das Open-Source-Tool Notepad++. Ziel ist es, dass Nutzer eine Anwendung schnell herunterladen, installieren und mit minimalem Aufwand nutzen können.
In diesem Abschnitt sollten Sie den Nutzern verdeutlichen, dass einige/viele Windows-Anwendungen tatsächlich unter FreeBSD ausgeführt werden können, was FreeBSD zu einer geeigneten Wahl für den täglichen Einsatz macht.
Ziel der Woche:Identifizierung einer kleinen Anzahl von Programmen, die sich sauber installieren lassen und (weitgehend) ohne weitere Anpassungen funktionieren, sowie eine ausgearbeitete Entwurfsversion der Abschnitte, in denen die Installation veranschaulicht wird.
*** Woche 4 (5.–9. Oktober): WINE – Übersicht und Konzepte
Am Ende des vorherigen Abschnitts wurde darauf hingewiesen, dass einige Anwendungen angepasst werden müssen, damit sie unter WINE funktionieren. An dieser Stelle ist eine Einführung in das WINE-Subsystem hilfreich, um den Kontext zu verdeutlichen. In diesen Abschnitten wird untersucht, was zum WINE-System gehört, wie es mit FreeBSD interagiert und wo Nutzer nach weiteren Informationen zum System oder zur Fehlerbehebung suchen können.
Dieser Abschnitt soll nicht bestehende Ressourcen duplizieren, sondern eine strukturierte Übersicht bieten, die zu weiteren (leicht verständlichen) Quellen mit weiteren Informationen verlinkt.
Ziel der Woche:Ein ausgearbeiteter Entwurf der Abschnitte, in denen das WINE-Subsystem den Nutzern vorgestellt wird.
*** Woche 5 (12.–16. Oktober): WINE-Konfiguration unter FreeBSD
In diesen Abschnitten wird die tatsächliche Konfiguration von WINE genauer erläutert, beginnend mit allgemeinen Änderungen/Optimierungen, die speziell für FreeBSD gelten. Sie würden auch die Verwendung von $WINEPREFIX-Ordnern veranschaulichen, mit denen die WINE-Umgebung für eine bestimmte Anwendung angepasst werden kann. Da es bereits Ressourcen gibt, in denen dieses Konzept ausführlich erklärt wird, würde dieser Abschnitt nur eine mäßig detaillierte Einführung bieten, bevor Links zu diesen Ressourcen geteilt werden.
Ziele der Woche:Ein ausgearbeiteter Entwurf der Abschnitte, in denen beschrieben wird, wo, wie und unter welchen Umständen eine ausführliche WINE-Konfiguration erforderlich ist.
*** Woche 6 (19.–23. Oktober): WINE-GUIs unter FreeBSD
Die Einrichtung von WINE für die Ausführung eines bestimmten Programms kann komplex und zeitaufwendig sein. Es gibt jedoch Hilfstools, die diesen Prozess erleichtern. Dieser Abschnitt bietet einen Überblick über die Installation und Verwendung einiger der Optionen von FreeBSD, darunter:
- WINECfg
- Weintricks
- playonbsd
- andere als verfügbar
Ziel der Woche:Ausgearbeitete Abschnitte mit Anleitungen zur Installation und Verwendung möglichst vieler der beliebtesten WINE-Hilfsanwendungen für die grafische Benutzeroberfläche bereitstellen.
*** Woche 7 (26.–30. Oktober): WINE/FreeBSD-FAQs (Recherche)
Einige der wertvollsten Informationen zu komplexen technischen Anwendungen wie WINE finden Sie in der Interaktion zwischen Nutzern, die bestimmte Probleme lösen möchten, und Experten, die Antworten geben. Es würde den Nutzern viel Zeit sparen, wenn einige dieser FAQs, insbesondere diejenigen, die FreeBSD-Nutzer betreffen, an einem Ort gesammelt würden.
Diese Abschnitte sollen genau das tun. Ich würde diese Woche damit verbringen, die Arten von Problemen zu recherchieren, die FreeBSD-Nutzer häufig mit WINE haben, sowie nach den Antworten zu suchen und diese (soweit möglich) zu testen. Dadurch erhalten die Leser dieses Handbuchs viel bessere Chancen, ein bestimmtes Problem schnell zu lösen.
Diese Abschnitte enthalten auch eine Liste mit Ressourcen, in denen Sie nach Antworten suchen können, die nicht in der FAQ enthalten sind.
Ziel der Woche:Ausgearbeitete Abschnitte mit den häufigsten WINE-Problemen, die entweder von FreeBSD-Nutzern oder allgemein auftreten, sowie Links/Hinweise zu deren Lösungen. Die Arbeit dieser Woche hat zwar keinen Entwurf als Ergebnis, erfordert aber wahrscheinlich einen größeren Zeitaufwand, um häufige Probleme zu finden und zu beheben sowie ihre Lösungen zu finden. Ich würde für diese Recherche eher 8 bis 10 Stunden einplanen.
*** Woche 8 (2.–6.11.): FAQs zu WIN/FreeBSD
Diese Woche würden Sie die Recherchen aus Woche 7 zusammenfassen, um die Abschnitte zu häufig gestellten Fragen und zur Fehlerbehebung zu erstellen. Gegebenenfalls sollten Sie auch Links zu Lösungen einfügen.
Ziel der Woche:Ein ausgearbeiteter Entwurf der Abschnitte mit häufig gestellten Fragen/häufig auftretenden Problemen und einer detaillierten Anleitung zur Behebung.
*** Woche 9 (9.11.–13.11.): WINE-Verwaltung für mehrere Nutzer
Diese Abschnitte enthalten eine Anleitung für Administratoren, die WINE in einem Mehrfachnutzerszenario bereitstellen möchten. Er umfasst nicht nur Best Practices zur gemeinsamen Nutzung des Subsystems selbst für mehrere Nutzer, sondern auch im Hinblick auf die in WINE eingesetzten Windows-Anwendungen.
Ziel der Woche:Ausgearbeitete Abschnitte mit Anleitungen und Best Practices für FreeBSD-Administratoren zum Bereitstellen von WINE- und WINE-basierten Anwendungen für mehrere Nutzer.
*** Woche 10 (16.–20. November): Anhänge, Feedback zur Prüfung und Verwaltungsaufgaben
Ich werde mich bemühen, während des gesamten Erarbeitungsprozesses alle Rückmeldungen von Mentoren und anderen Prüfern zu berücksichtigen. Diese Woche bietet jedoch Zeit für eine umfassendere Neuorganisation oder Neuformulierung, falls erforderlich.
Außerdem schreibe ich alle Verwaltungsaufgaben, die für dieses Kapitel des Handbuchs erforderlich sind (Vorderteil, Indizes usw.), und stelle weitere Lesematerialien zu WINE zusammen (z.B. Nutzung der Linux-Version von WINE über Binärkompatibilität, DOSBox für alte Spiele/Programme usw.).
Ziel der Woche:Ein ausgearbeiteter Entwurf des gesamten Handbuchkapitels, einschließlich aller anderen Abschnitte.
*** Woche 11 (23.–27. November): Fertigstellung des Handbuchkapitels
Ich würde vorhaben, diese vorletzte Woche damit zu widmen, den gesamten Text zu prüfen, Bilder zu überprüfen und die verschiedenen Ausgaben (HTML, PDF usw.) nach Bedarf zu testen. Diese Woche können auch Updates vorgenommen werden, falls eine der oben genannten Software (von FreeBSD selbst bis WINE oder seinen Hilfsprogrammen) in der Zeit seit der Erstveröffentlichung aktualisiert wurde.
Wochenziel:Finale Version des Handbuchkapitels mit allen erforderlichen Aktualisierungen.
*** Woche 12 (30. 11. bis 5. 12.): Projektabschluss
In Absprache mit den Projektmentoren würde ich das Kapitel des Handbuchs in die Versionskontrolle aufnehmen, den Projektbericht zusammenstellen und das Projekt als abgeschlossen einreichen.