Diese Seite wurde von der Cloud Translation API übersetzt.

VideoLAN-Projekt

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:: VideoLAN
Technischer Redakteur:: Edidiong Anny Asikpo
Projektname:: VLC-Nutzerdokumentation modernisieren (neu schreiben)
Projektdauer:: Standarddauer (3 Monate)

Projektbeschreibung

Abstrakt

Eine Nutzerdokumentation soll Endnutzer bei der Verwendung eines Produkts oder einer Dienstleistung unterstützen. Eine gute Benutzerdokumentation ist sehr wichtig, da sie Nutzenden die Möglichkeit bietet, die Verwendung einer Software zu erlernen, ihre Funktionen, Tipps und Tricks sowie die Lösung häufig auftretender Probleme bei der Verwendung der Software. Sie reduziert auch die Supportkosten und ist Teil der Corporate Identity des Produkts: Eine gute Nutzerdokumentation ist ein Zeichen für die Integrität des Produkts, also das Entwicklerteam.

Ohne eine gute Nutzerdokumentation wissen Nutzende möglicherweise nicht, wie sie die oben genannten Dinge effektiv und effizient erledigen können. Benutzerdokumentationen können eine entscheidende Rolle für den Erfolg eines Produkts spielen, da gute Kommunikation das Herzstück eines Unternehmens oder Produkts ist und immer sein wird. Eine gute Dokumentation fügt diese Kommunikation einfach in ein überschaubares Framework ein, auf das jeder Zugriff hat, um erfolgreich zu sein.

Zum Zeitpunkt der Veröffentlichung dieses Artikels wurde die VLC-Nutzerdokumentation 4.634.065 Mal aufgerufen und der VLC-Mediaplayer wird jeden Monat etwa 23 Millionen Mal von der Hauptwebsite heruntergeladen. Dies zeigt, dass weltweit viele Nutzer den VLC Media Player verwenden und die Nutzerdokumentation für die Verwendung des Mediaplayers möglicherweise lesen möchten. Die Nutzerdokumentation für den VLC-Mediaplayer ist derzeit jedoch veraltet und unvollständig. Sie wurde zuletzt am 28. Oktober 2015 geändert. Die VideoLAN-Community möchte die Nutzerdokumentation mithilfe dieses Projekts verbessern, um Endnutzern eine nahtlose Verwendung des VLC-Mediaplayers zu ermöglichen.

AKTUELLER STATUS

Derzeit steht die Nutzerdokumentation auf einer Wiki-Seite zur Verfügung. Er ist veraltet, unvollständig, schwer zu navigieren oder zu finden. Er deckt keine Informationen zur aktuellen Version des Mediaplayers ab und kann nur ins Deutsche übersetzt werden, was für Menschen, die die englische Sprache nicht lesen können, einen großen Rückschlag bedeuten.

WARUM IST DIE VORGESCHLAGENE NUTZERDOKUMENTATION IM AKTUELLEN VERBESSERUNGSVORGANG?

Die vorgeschlagene Nutzerdokumentation ist so strukturiert, dass sie Effizienz, Einheitlichkeit und ein sicheres Gefühl für Endnutzer gewährleistet. Der Leitfaden enthält schriftliche Anleitungen und die zugehörigen Bilder sowie Anleitungen und Erklärungen zur Verwendung der einzelnen Funktionen des VLC media player. Sie sind aktuell, einfach zu navigieren, verständlich und übersetzbar in mindestens fünf Hauptsprachen.

Mentoren: Jean-Baptiste, Alex, Simon

ANALYSE

Jean-Baptiste und ich unterhielten uns über die neue Umgebung, in die die aktuelle Nutzerdokumentation zur Verbesserung migriert werden würde. Er teilte zwei Links mit einem Gitlab-Repository der mit Sphinx geschriebenen Quelldatei und der auf Read the Docs gehosteten Hauptdokumentation. Er sagte, dass sie erwarten, dass die neue Dokumentation dieser ähnlich sein wird. Ich habe viel über diese Tools recherchiert, um besser zu verstehen, wie sie funktionieren.

Sphinx

Sphinx ist eine robuste und ausgereifte Lösung für die Softwaredokumentation. Sie umfasst eine Reihe von Funktionen, die Autoren erwarten, darunter Single Source-Veröffentlichung, Wiederverwendung von Inhalten durch Einfügungen, bedingte Einfügungen basierend auf Inhaltstyp und Tags, mehrere ausgereifte HTML-Designs, die eine gute Nutzererfahrung auf Mobilgeräten und Desktop-Computern bieten, Verweise auf Seiten, Dokumente und Projekte, Unterstützung von Indexen und Glossaren sowie Unterstützung bei der Internationalisierung. Außerdem wird reStructuredText als Auszeichnungssprache verwendet. Viele seiner Stärken sind auf die Leistungsfähigkeit und Einfachheit von reStructuredText und die Möglichkeit zur Übersetzung der Dokumentation zurückzuführen.

Dokumentation lesen

Lesen Sie das Google Text & Tabellen , um die Softwaredokumentation zu vereinfachen, indem die Erstellung, Versionierung und das Hosting Ihrer Dokumente für Sie automatisiert werden. Das heißt, wenn Sie Code an Ihr bevorzugtes Versionskontrollsystem (Git, Mercurial, Bazaar oder Subversion) übertragen, erstellt Read the Docs Ihre Dokumente automatisch, sodass Ihr Code und Ihre Dokumentation immer auf dem neuesten Stand sind. Es gibt mehrere Versionen. Mit Lesen der Dokumente können mehrere Versionen Ihrer Dokumente gehostet und erstellt werden. Eine 1.0-Version Ihrer Dokumente und eine 2.0-Version Ihrer Dokumente sind daher genauso einfach wie die Verwendung eines separaten Zweigs oder Tags in Ihrem Versionskontrollsystem. Read the Docs ist kostenlos und eine Open-Source-Software. Hier finden Sie die Dokumentation für fast 100.000 große und kleine Open-Source-Projekte in nahezu jeder menschlichen und Computersprache.

VERDICT

Sphinx ist ein unglaublich leistungsstarkes Tool. Read the Docs baut darauf auf und bietet Hosting für die Sphinx-Dokumentation, sodass Ihre Dokumente über alle Versionen hinweg auf dem neuesten Stand sind. Gemeinsam stellen sie eine großartige Auswahl an Tools dar, mit denen Entwickler und technische Redakteure Benutzerdokumentationen 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, bei dem jeder die richtigen Informationen bearbeiten und nicht hinzufügen kann, würde dieses Versionskontrollsystem sicherstellen, dass alle Änderungen zuerst geprüft werden, bevor sie im Haupt-Repository zusammengeführt werden. Die Versionsverwaltung führt auch dazu, dass die Dokumentation den Open-Source-Beitrag zum Projekt erhöht, da Nutzer Probleme, offene Pull-Anfragen usw. erstellen können. Sphinx und das Lesen der Dokumente werden von einer Liste anderer großartiger und Communities wie ASP.NET, Kernel, Julia, Jupyter, PHPMyAdmin, Write the Docs usw. verwendet. Es ist ein großartiges Tool für die neue VLC-Nutzerdokumentation.

Ich habe nicht nur etwas über diese Tools gelesen, sondern auch ein einfaches Beispiel erstellt. Dies ist der Link https://gitlab.com/Didicodes/demo-vlc-user-documentation zu meinem Gitlab-Repository. 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 VORGESCHLAGENEN 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 die Implementierung dieser neuen Struktur beginnt, muss sie von den beratenden Personen genehmigt werden. Das bedeutet, dass sich die Struktur wahrscheinlich ändern wird, nachdem sie von den Mentoren überprüft wurde.

PROJEKTZIELE

Dokumentation neu strukturieren
Aktualisieren Sie die Dokumentation, um sie an die aktuellen Versionen von VLC anzupassen.
Migrieren Sie die Nutzerdokumentation mithilfe von Sphinx und ReadtheDocs zu Gitlab.
Veraltete Bilder und Informationen entfernen
Die Nutzerdokumentation überarbeiten, um sie leichter verständlich zu machen.
Richten Sie es für die Übersetzung mit der Sphinx-Internationalisierung ein.
Gestalten Sie die Dokumentationscommunity so, dass Nutzer Probleme beim Lesen der Dokumentation melden oder lösen können.

WARUM DIESES PROJEKT?

Ich war schon immer davon überzeugt, dass das Schreiben von Code, das Lösen von Problemen und das Erstellen von Software ihr volles Potenzial entfalten können, wenn man auch in der Lage ist, andere durch Schreiben davon aufzuklären. Ich persönlich war schon immer von den Bemühungen der VideoLAN-Community fasziniert, kostenlose Softwarelösungen für Multimedia zu entwickeln. Als Kind war der VLC-Mediaplayer immer die Software, die ich beim Musikhören oder Ansehen eines Films verwendet habe, weil er sehr laut war und aus so vielen Funktionen bestand. Es ist mir eine Ehre, mit der Community zusammenzuarbeiten, die meine Kindheit zu einem tollen Tag gemacht hat.

WARUM bin ICH DIE RICHTIGE PERSON FÜR DIESES PROJEKT?

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

Ich habe in der Vergangenheit Erfahrung bei der Verbesserung der Dokumentation von Organisationen und kann jedes Versionskontrollsystem verwenden, sodass die Ausführung von Befehlen in Gitab kein Problem sein wird. Was mich antreibt, ist die Arbeit an Projekten, die einen Mehrwert für die Menschen schaffen.
Wenn Sie möchten, dass jemand etwas möglichst effizient macht, dokumentieren Sie das. Durch die Dokumentation Ihrer Prozesse sorgen Sie für Effizienz, Einheitlichkeit und ein beruhigendes Gefühl für alle Beteiligten.
Ich kenne die Bedürfnisse der VLC-Nutzenden, weil ich dazu gehöre. Auf diese Weise können Sie die Dokumentation so schreiben, dass alle Nutzenden weltweit sie auf den ersten Blick verstehen.