Diese Seite wurde von der Cloud Translation API übersetzt.

VideoLAN-Projekt

Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:: VideoLAN
Technischer Redakteur:: Edidiong Anny Asikpo
Projektname:: VLC-Nutzerdokumentation modernisieren (umschreiben)
Projektlänge:: Standardlänge (3 Monate)

Projektbeschreibung

ABSTRACT

Eine Nutzerdokumentation soll Endnutzer bei der Verwendung eines Produkts oder Dienstes unterstützen. Eine gute Nutzerdokumentation ist sehr wichtig, da sie Nutzern die Möglichkeit bietet, die Verwendung einer Software, ihre Funktionen, Tipps und Tricks zu erlernen und auch häufige Probleme bei der Verwendung der Software zu beheben. Außerdem werden dadurch die Supportkosten gesenkt und die Dokumentation ist Teil der Corporate Identity des Produkts: Eine gute Nutzerdokumentation ist ein Zeichen für die Gesundheit des Produkts und des Entwicklerteams.

Ohne eine gute Nutzerdokumentation weiß der Nutzer möglicherweise nicht, wie er die oben genannten Dinge effektiv und effizient erledigen kann. Benutzerdokumentationen können eine entscheidende Rolle für den Erfolg eines Produkts spielen, da gute Kommunikation im Mittelpunkt jedes Unternehmens oder Produkts steht und bleibt. Eine gute Dokumentation stellt diese Kommunikation einfach in ein überschaubares Framework ein, auf das jeder zugreifen kann, um erfolgreich zu sein.

Zum Zeitpunkt der Erstellung dieses Dokuments wurde 4.634.065 Mal auf die VLC-Nutzerdokumentation zugegriffen und der VLC-Mediaplayer wird etwa 23 Millionen Mal pro Monat von der Hauptwebsite heruntergeladen. Das zeigt, dass viele Nutzer auf der ganzen Welt den VLC Media Player verwenden. In der Nutzerdokumentation finden Sie Hinweise zur Verwendung des Mediaplayers. Die Nutzerdokumentation des VLC Media Players ist jedoch derzeit veraltet und unvollständig (sie wurde zuletzt am 28. Oktober 2015 geändert). Die VideoLAN-Community möchte dieses Projekt nutzen, um die Nutzerdokumentation zu verbessern, damit Endnutzer den VLC Media Player reibungslos nutzen können.

AKTUELLER STATUS

Derzeit ist die Nutzerdokumentation auf einer Wiki-Seite verfügbar. Sie ist veraltet, unvollständig, schwer zu navigieren oder Informationen zu finden, enthält keine Informationen über die aktuelle Version des Mediaplayers und kann nur ins Deutsche übersetzt werden, was für Menschen, die die englische Sprache nicht lesen können, einen großen Rückschlag bedeutet.

WARUM IST MEINE VORGESCHLAGENE NUTZERDOKUMENTATION EINE VERBESSERUNG GEGENÜBER DER AKTUELLEN?

Die vorgeschlagene Nutzerdokumentation soll die Effizienz, Konsistenz und Sicherheit für Endnutzer verbessern und gewährleisten. Sie enthält schriftliche Anleitungen und zugehörige Bilder sowie eine Anleitung und Erläuterungen zur Verwendung der einzelnen Funktionen des VLC Mediaplayers. Sie muss auf dem neuesten Stand, nutzerfreundlich, verständlich und in mindestens fünf gängigen Sprachen übersetzbar sein.

Mentoren: Jean-Baptiste, Alex, Simon

ANALYSE

Jean-Baptiste und ich haben uns über die neue Umgebung unterhalten, in die die aktuelle Nutzerdokumentation zur Verbesserung migriert werden soll. Er hat mir zwei Links zu einem Gitlab-Repository der mit Sphinx geschriebenen Quelldatei und zur Hauptdokumentation auf Read the Docs gesendet. Er erwartet, dass die neue Dokumentation ähnlich sein wird. Ich habe viel über diese Tools recherchiert, um ihre Funktionsweise besser zu verstehen.

Sphinx

Sphinx ist eine robuste und ausgereifte Lösung für die Softwaredokumentation. Es umfasst eine Reihe von Funktionen, die Autoren erwarten, z. B. Single Source-Veröffentlichung, Wiederverwendung von Inhalten, bedingte Einbeziehen auf der Grundlage von Inhaltstyp und Tags, mehrere nicht jugendfreie HTML-Designs, die eine hervorragende Nutzererfahrung auf Mobilgeräten und Computern bieten, sowie Verweise auf Seiten, Dokumente und Projekte Unterstützung von Index- und Glossaren sowie Unterstützung für die Internationalisierung. Außerdem wird reStructuredText als Auszeichnungssprache verwendet. Viele seiner Stärken liegen in der Leistungsfähigkeit und Klarheit von reStructuredText und seiner Fähigkeit, Dokumentation zu übersetzen.

Dokumentation lesen

Read the Docs vereinfacht die Softwaredokumentation, indem das Erstellen, die Versionierung und das Hosting Ihrer Dokumente automatisiert wird. Es kommt nie zu Unstimmigkeiten. Das heißt, wenn Sie Code in Ihr bevorzugtes Versionskontrollsystem (Git, Mercurial, Bazaar oder Subversion) übertragen, wird mit Read the Docs automatisch Ihre Dokumentation erstellt, sodass Ihr Code und Ihre Dokumentation immer auf dem neuesten Stand sind. Es gibt mehrere Versionen: Read the Docs kann mehrere Versionen Ihrer Dokumente hosten und erstellen. So ist es genauso einfach, eine Version 1.0 und eine Version 2.0 Ihrer Dokumente zu haben, wie einen separaten Branch oder Tag in Ihrem Versionskontrollsystem. Read the Docs ist kostenlos und Open Source und beherbergt Dokumentationen für fast 100.000 große und kleine Open-Source-Projekte in fast allen menschlichen und Computersprachen.

ABGESCHLOSSEN

Sphinx ist ein unglaublich leistungsstarkes Tool und Read the Docs bietet Hosting für Sphinx-Dokumentation, mit dem Ihre Dokumente über alle Versionen hinweg auf dem neuesten Stand gehalten werden. Zusammen ergeben sie eine Reihe von Tools, mit denen Entwickler und technische Redakteure Nutzerdokumentationen erstellen können, die für Endnutzer am besten geeignet sind.

Sphinx unterstützt die Übersetzung von Dokumentationen in mehrere Sprachen. Sie unterstützt die Versionsverwaltung, die zur Verwaltung der Dokumentation verwendet wird. Im Gegensatz zum aktuellen Wiki, in dem jeder die richtigen Informationen bearbeiten und hinzufügen kann, würde dieses Versionskontrollsystem dafür sorgen, dass alle Änderungen zuerst geprüft werden, bevor sie in das Haupt-Repository zusammengeführt werden. Durch die Versionskontrolle wird auch der Open-Source-Beitrag zur Dokumentation erhöht, da Nutzer Probleme erstellen, Pull-Anfragen öffnen usw. können. Sphinx und Read the Docs werden von einer Reihe anderer großartiger Communitys wie ASP.NET, Kernel, Julia, Jupyter, PHPMyAdmin, Write the Docs usw. verwendet und sind ein hervorragendes Tool für die neue VLC-Nutzerdokumentation.

Ich habe mir nicht nur Informationen zu diesen Tools angesehen, sondern auch ein einfaches Beispiel erstellt. Hier ist der Link zu meinem Gitlab-Repository: https://gitlab.com/Didicodes/demo-vlc-user-documentation. Die gehostete Version auf readthedocs finden Sie hier: [https://vlc-user-documentation-demo.readthedocs.io/en/latest/](https://vlc-user-documentation-demo.readthedocs.io/en/latest/.

STRUKTUR DER VORGESEHENEN DOKUMENTATION

Ich habe eine Struktur für die VLC-Nutzerdokumentation erstellt, die Sie hier finden: https://docs.google.com/document/d/1Sy2V2IADoCyfnGBK70v8mkjiWK2tH-oWdUlDxAfQAYA/edit?usp=sharing. Bevor mit der Implementierung dieser neuen Struktur begonnen wird, muss sie von den Mentoren genehmigt werden. Das bedeutet, dass sich die Struktur wahrscheinlich ändern wird, nachdem sie von den Mentoren überprüft wurde.

PROJEKTZIELE

Strukturieren Sie die Dokumentation neu.
Aktualisieren Sie die Dokumentation auf die modernen Versionen von VLC.
Migrieren Sie die Nutzerdokumentation mit Sphinx und ReadtheDocs zu Gitlab.
Veraltete Bilder und Informationen entfernen
Überarbeiten Sie die Nutzerdokumentation, damit sie leichter verständlich ist.
Richten Sie es für die Übersetzung mithilfe von Sphinx Internationalization ein.
Gestalten Sie die Dokumentations-Community so, dass Nutzer Probleme beim Lesen der Dokumentation melden oder lösen können.

WARUM DIESES PROJEKT?

Ich war immer davon überzeugt, dass das Schreiben von Code, das Lösen von Problemen und das Entwickeln von Software ihr volles Potenzial entfalten, wenn Sie auch die Möglichkeit haben, andere durch Schreiben darüber zu informieren. Ich persönlich war schon immer fasziniert von den Bemühungen der VideoLAN-Community, kostenlose Softwarelösungen für Multimedia zu entwickeln. Der VLC-Mediaplayer war als Kind immer die Software, die ich zum Musikhören oder Ansehen eines Films verwendete, weil er sehr laut war und so viele Funktionen enthielt. Es ist mir eine Ehre, mit der Community zusammenzuarbeiten, die meine Kindheit so toll gemacht hat.

WARUM bin ich die richtige Person für dieses Projekt?

Ich glaube, dass ich die richtige Person für dieses Projekt bin, weil:

Ich habe bereits Erfahrung mit der Verbesserung der Dokumentation von Organisationen und kann jedes Versionskontrollsystem verwenden. Daher ist es kein Problem, Befehle in Gitab auszuführen. Außerdem motiviert mich die Arbeit an Projekten, die einen Mehrwert für Menschen schaffen.
Wenn Sie möchten, dass jemand etwas auf möglichst effiziente Weise erledigt, sollten Sie es dokumentieren. Wenn Sie Ihre Prozesse dokumentieren, sorgen Sie für Effizienz, Konsistenz und Sicherheit für alle Beteiligten.
Ich kenne die Anforderungen der VLC-Nutzer, weil ich selbst einer bin. So können Sie die Dokumentation so verfassen, dass sie auf den ersten Blick für jeden Nutzer auf der ganzen Welt verständlich ist.