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:
- Das FreeBSD-Projekt
- Technischer Redakteur:
- Kuchen
- Projektname:
- Kapitel im Weinhandbuch erstellen
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Im Rahmen dieser Initiative würde ich ein ausführliches Kapitel des FreeBSD-Handbuchs in Handbüchern veröffentlichen, in dem es um die Installation, Nutzung und Fehlerbehebung von WINE (www.winehq.org) auf FreeBSD geht. Sofern nicht anders angegeben, würde ich versuchen, jede Woche 4–8 Stunden pro Woche an den folgenden Punkten zu arbeiten.
*** Community-Beziehung
Bei der Auswahl würde ich die Community Bonding-Phase damit verbringen, mich mit den Dokumentationsprozessen und der Infrastruktur des FreeBSD-Projekts vertraut zu machen. Ich war immer von der zusammenhängenden Dokumentation des Projekts beeindruckt und ich würde mich mit den Teammitgliedern des Projekts über ihren Workflow austauschen. Ich würde auch in nutzerorientierten Foren stöbern, um zu erfahren, was FreeBSD-Nutzern im Allgemeinen und insbesondere bei der Arbeit mit WINE an FreeBSD helfen würde.
In dieser Phase würde ich mich mit der Toolchain für die Dokumentation des Projekts vertraut machen. So kann ich gleich in den ersten Wochen des Projekts loslegen, falls ich ausgewählt werde.
*** Woche 1 (14.09.–19. September): Testinstallationen und Fehlerbehebung
Ich verbrachte die erste Woche der Dokumententwicklungsphase damit, eine Probeinstallation von WINE auf der aktuellen stabilen Version von FreeBSD durchzuführen und eine Vielzahl von Windows-Anwendungen zu installieren und auszuführen, von einfachen Dienstprogrammen bis hin zu komplexeren Anwendungen. Diesen Ansatz habe ich in einem ähnlichen Artikel zu ReactOS für MakeUseOf verfolgt (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/). Nur ich würde die Zeit der ersten Woche nutzen, um eine breitere Auswahl an Programmen zu untersuchen.
Nach meiner Erfahrung ist es nützlich, im Vorfeld allgemeine Probleme zu identifizieren und zu beheben. Auf diese Weise kann ich die Lösungen nutzen, wenn es tatsächlich an der Zeit ist, relevante Abschnitte zu schreiben, oder zumindest Unterstützung bei den entsprechenden Kanälen anfordern.
Ziel der Woche: Eine Zusammenfassung der Installationskapitel und notwendige Details zur Behebung häufiger Installationsprobleme.
*** Woche 2 (21.09.–25.9.): Dokumentation der WINE-Installation
In Woche 2 erstellte ich den oder die Abschnitte, die die Installation von WINE mithilfe beliebter Methoden veranschaulichten, darunter:
- Von der Quelle über das Portsystem;
- Über Binärpakete, die Kern-Repositories verwenden
- Verfügbare GUI-Paketmanager verwenden, falls verfügbar
- Aus alternativen Repositories wie FreshPorts (und warum ein Nutzer das tun möchte)
Wichtig für diesen Abschnitt ist eine Diskussion von 32- und 64-Bit- und gleichzeitigen Installationen, um die zusätzlichen Schritte hervorzuheben, die für das Ausführen von Programmen unterschiedlicher Architekturen erforderlich sind.
Ziel der Woche: Ein ausgearbeiteter Entwurf der Abschnitte, in denen die Installation von WINE auf FreeBSD beschrieben wird. Dieser „ausgearbeitete Entwurf“ sollte nahezu den endgültigen Text beinhalten (vorausgesetztes Korrekturlesen und Feedback prüfen) und Platzhalter für Screenshots, wenn nicht die Screenshots selbst.
*** Woche 3 (28.09.–02.10.): Dein erstes WINE-Programm auf FreeBSD
Sobald das WINE-Subsystem installiert ist, werden 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-Programm Notepad++. Das Ziel ist es, Nutzern das schnelle Herunterladen und Installieren einer Anwendung zu ermöglichen, damit sie schnell und einfach funktionieren.
Dieser Abschnitt ist wichtig, um Nutzern zu zeigen, dass einige oder viele Windows-Anwendungen tatsächlich mit FreeBSD ausgeführt werden können, was diese Anwendung zu einer praktikablen Wahl für den Alltag macht.
Ziel der Woche: Die Identifizierung einiger weniger Programme, die sauber installiert werden und (weitgehend) sofort einsatzbereit sind, sowie ein ausgefeilter Entwurf der Abschnitte, die deren Installation veranschaulichen.
*** Woche 4 (5. bis 9. Oktober): Übersicht und Konzepte von WINE
Das Ende des vorherigen Abschnitts würde darauf hinweisen, dass einige Feinabstimmungen und Anpassungen vorgenommen werden müssen, damit bestimmte Anwendungen auf WINE funktionieren. An dieser Stelle ist eine Einführung in das WINE-Subsystem nützlich, um Kontext bereitzustellen. In diesem Abschnitt bzw. in den Abschnitten wird untersucht, was im WINE-System enthalten ist, wie es mit FreeBSD interagiert und wo Nutzer damit beginnen können, das System weiter zu verstehen oder Probleme zu beheben.
Dabei ist zu beachten, dass es in diesem Abschnitt nicht darum geht, vorhandene Ressourcen zu duplizieren, sondern eine Übersicht, die Links zu anderen (leicht verständlichen) Quellen für weitere Informationen bietet.
Ziel der Woche: Ein ausgefeilter Entwurf der Abschnitte, in denen Nutzern das Subsystem WINE vorgestellt wird.
*** Woche 5 (12.10.–16.10.): WINE-Konfiguration auf FreeBSD
Dieser Abschnitt bzw. diese Abschnitte würden weiter mit der tatsächlichen Konfiguration von WINE beginnen, beginnend mit allgemeinen Modifikationen/Feinabstimmungen speziell für FreeBSD. 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 Ressourcen gibt, in denen dieses Konzept ausführlich erläutert wird, bietet dieser Abschnitt nur eine mäßig detaillierte Einführung, bevor auf sie verlinkt wird.
Ziele der Woche: Ein ausgefeilter Entwurf der Abschnitte, in denen erläutert wird, wo, wie und unter welchen Umständen eine detaillierte WINE-Konfiguration erforderlich ist.
*** Woche 6 (19.10.–23.10.): WINE GUIs auf FreeBSD
In dem Maße, wie das Einrichten von WINE zur Ausführung eines bestimmten Programms eine komplexe und zeitaufwändige Aufgabe sein kann, gibt es Hilfstools, die diesen Prozess vereinfachen. Dieser Abschnitt bzw. diese Abschnitte bieten einen Überblick über die Installation und Verwendung einiger Optionen, die bei FreeBSD verfügbar sind, darunter:
- WINECfg
- Weintricks
- Playonbsd
- andere, je nach Verfügbarkeit
Ziel der Woche: Ausgefeilte Entwurfsabschnitte mit Anleitungen zur Installation und Verwendung so vieler der beliebtesten GUI WINE-Hilfsanwendungen wie möglich bereitstellen.
*** Woche 7 (26.10.–30.10.): FAQs zu WINE/FreeBSD (Forschung)
Einige der wertvollsten Informationen zu komplexen technischen Anwendungen wie WINE finden sich in der Interaktion zwischen Nutzenden, die bestimmte Probleme lösen, und von Fachleuten, die Antworten geben. Es spart Nutzern viel Zeit, wenn einige dieser häufig gestellten Fragen, insbesondere solche, die sich auf FreeBSD-Nutzer auswirken, an einem Ort gesammelt werden.
Dieser Abschnitt bzw. die Abschnitte würden genau das tun und ich würde diese Woche damit verbringen, die Arten von Problemen zu untersuchen, die FreeBSD-Nutzer häufig mit WINE haben, sowie nach Antworten zu suchen und (soweit möglich) zu testen. So erhalten die Leser dieses Kapitels dieses Handbuchs viel bessere Chancen, ein bestimmtes Problem schnell zu lösen.
Dieser Abschnitt würde auch eine Liste von Ressourcen enthalten, in denen Sie nach Antworten suchen können, die er nicht gegeben hat.
Ziel der Woche:Überarbeitete Entwurfsabschnitte mit den häufigsten WINE-Problemen, entweder aus Sicht der FreeBSD-Nutzer oder allgemein, sowie Links/Hinweise zu deren Lösungen. Hinweis: Auch wenn es für die Arbeit in dieser Woche keine Entwürfe gibt, wird es wahrscheinlich mehr Zeit in Anspruch nehmen, häufige Probleme zu finden und zu beheben sowie Lösungen zu finden. Ich würde 8 bis 10 Stunden für diese Forschung aufwenden.
*** Woche 8 (2.–6.11.): Häufig gestellte Fragen zu WINE/FreeBSD
Diese Woche würde das Zusammenführen der Forschungsarbeiten aus Woche 7 aufgewendet werden, um einen oder mehrere Bereiche zu FAQs/häufigen Problemen zur Fehlerbehebung zu erstellen (nach Bedarf entsprechende Links zu Lösungen).
Ziel der Woche: Ein ausgefeilter Entwurf der Abschnitte mit häufig gestellten Fragen und häufig auftretenden Problemen sowie Schritt-für-Schritt-Anleitungen zu deren Lösung.
*** Woche 9 (09.11.–13.13.): WINE-Verwaltung mit mehreren Nutzern
In diesem Abschnitt bzw. in diesen Abschnitten finden Administratoren Anleitungen, die WINE in einem Szenario mit mehreren Nutzern bereitstellen möchten. Es würde nicht nur Best Practices für die gemeinsame Nutzung des Subsystems an sich für mehrere Nutzer umfassen, sondern auch in Bezug auf die Windows-Anwendungen, die in WINE bereitgestellt werden.
Ziel der Woche: Ausgearbeitete(r) Entwurfsabschnitte mit Anleitungen und Best Practices für FreeBSD-Administratoren zur Bereitstellung von WINE- und WINE-basierten Anwendungen für mehrere Nutzer.
*** Woche 10 (16.–20.11.): Anhänge, Feedback zur Überprüfung und Verwaltung
Obwohl ich versuchen würde, während des Entwurfsprozesses das Feedback von Mentoren und anderen prüfenden Personen umzusetzen, würde diese Woche bei Bedarf mehr Zeit für umfassendere Umstrukturierungen/Umformulierungen geben.
Außerdem würde ich in dieser Zeit alle für dieses Handbuch erforderlichen Verwaltungsaufgaben schreiben (Anfangsache, Indizes usw.) und WINE-weitere Lesematerialien zusammenstellen (z.B. Verwendung der Linux-Version von WINE durch Binärkompatibilität, DOSBox für alte Spiele/Programme usw.).
Ziel der Woche:Ein ausgefeilter Entwurf des gesamten Kapitels des Handbuchs, einschließlich aller anderen Abschnitte.
*** Woche 11 (23.11.–27.11.): Abschluss der Kapitel im Handbuch
In der zweiten bis letzten Woche würde ich den gesamten Text Korrektur lesen, Bilder überprüfen und die verschiedenen Ausgaben (HTML, PDF usw.) nach Bedarf testen. Diese Woche wird auch Updates für den Fall zulassen, dass eine der oben genannten Software (von FreeBSD selbst auf WINE oder seine Hilfsprogramme) in der Zeit seit ihrer ursprünglichen Erstellung aktualisiert wird.
Ziel der Woche: Letzte Version des Kapitels des Handbuchs, einschließlich aller erforderlichen Aktualisierungen.
*** Woche 12 (30.11.–05.12.): Projektabschluss
In Absprache mit den Mentoren des Projekts würde ich das Kapitel des Handbuchs zur Versionsverwaltung aufrufen, den Projektbericht zusammenstellen und das Projekt als abgeschlossen einreichen.