Diese Seite wurde von der Cloud Translation API übersetzt.

VideoLAN-Projekt

Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:: VideoLAN
Technischer Redakteur:: Edidiong Anny Asikpo
Projektname:: VLC-Nutzerdokumentation modernisieren (umschreiben)
Projektdauer:: Standarddauer (3 Monate)

Projektbeschreibung

ABSTRACT

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, den Umgang mit einer Software, ihre Funktionen, Tipps und Tricks zu erlernen und auch häufige Probleme zu lösen, die bei der Verwendung der Software auftreten. Sie reduziert auch die Supportkosten und ist Teil der Unternehmensidentität des Produkts: Eine gute Nutzerdokumentation ist ein Zeichen für die Integrität des Produkts, also das Entwicklerteam.

Ohne eine gute Benutzerdokumentation wissen Nutzende möglicherweise nicht, wie sie die oben genannten Dinge effektiv und effizient erledigen können. Benutzerdokumentationen können eine entscheidende Rolle bei der Gewährleistung des Produkterfolgs 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 einen überschaubaren Rahmen, auf den jeder Zugriff hat, um erfolgreich zu sein.

Zum Zeitpunkt der Erstellung dieses Dokuments wurde die VLC-Benutzerdokumentation 4.634.065 Mal aufgerufen und der VLC-Mediaplayer wird jeden Monat etwa 23 Millionen Mal von der Hauptwebsite heruntergeladen. Dies zeigt, dass viele Menschen auf der ganzen Welt den VLC Media Player verwenden und möglicherweise in der Benutzerdokumentation eine Anleitung zur Verwendung des Mediaplayers 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, damit Endnutzer den VLC-Mediaplayer problemlos verwenden können.

AKTUELLER STATUS

Die Nutzerdokumentation ist derzeit auf einer Wiki-Seite verfügbar. 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. Für Menschen, die die englische Sprache nicht lesen können, bedeutet das einen großen Rückschlag.

WARUM SIND MEIN VORGESCHLAGENE NUTZERDOKUMENTATION VERBESSERT?

Die vorgeschlagene Nutzerdokumentation ist so strukturiert, dass sie Effizienz, Einheitlichkeit und Sicherheit für Endnutzer verbessert und gewährleistet. Sie enthält schriftliche Leitfäden und die zugehörigen Bilder sowie Anleitungen und Erklärungen zur Verwendung der einzelnen Funktionen des VLC-Mediaplayers. Sie sind auf dem neuesten Stand, einfach zu navigieren, verständlich und in mindestens fünf Hauptsprachen übersetzt.

Mentoren: Jean-Baptiste, Alex, Simon

ANALYSE

Jean-Baptiste und ich führten eine Unterhaltung über die neue Umgebung, zu der die aktuelle Benutzerdokumentation 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 die neue Dokumentation davon ausgeht, dass sie dieser ähnlich sein wird. Ich habe mich viel über diese Tools informiert, um ihre Funktionsweise besser zu verstehen.

Sphinx

Sphinx ist eine robuste und ausgereifte Lösung für die Softwaredokumentation. Er umfasst eine Reihe von Funktionen, die Autoren erwarten, wie z. B. die Veröffentlichung in einer einzigen Quelle, die Wiederverwendung von Inhalten über Einschleusungen, bedingte Einfügungen basierend auf dem Inhaltstyp und den Tags, mehrere ausgereifte HTML-Designs, die eine hervorragende 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, die viele Stärken von reStructuredText und der Fähigkeit, Dokumentation zu übersetzen, liegt.

Dokumentation lesen

Read the Docs vereinfacht die Softwaredokumentation, indem das Erstellen, die Versionsverwaltung und das Hosting Ihrer Dokumente automatisiert werden. Das heißt, wenn Sie Code in Ihr bevorzugtes Versionskontrollsystem (Git, Mercurial, Bazaar oder Subversion) übertragen, erstellt Read the Docs automatisch Ihre Dokumente, sodass Ihr Code und Ihre Dokumentation immer auf dem neuesten Stand sind. Es gibt mehrere Versionen. Mit Read the Docs können mehrere Versionen Ihrer Dokumente gehostet und erstellt werden. Daher ist eine 1.0-Version Ihrer Dokumente und eine 2.0-Version Ihrer Dokumente genauso einfach wie ein separater Zweig oder ein separates Tag in Ihrem Versionskontrollsystem. Read the Docs ist kostenlos und als Open Source verfügbar. Hier finden Sie Dokumentationen für fast 100.000 große und kleine Open-Source-Projekte in fast 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 großartige Tools dar, 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. Es unterstützt die Versionsverwaltung, die zur Verwaltung der Dokumentation verwendet wird. Im Gegensatz zum aktuellen Wiki, in 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 mit dem Haupt-Repository zusammengeführt werden. Die Versionskontrolle führt auch dazu, dass die Dokumentation den Open-Source-Beitrag zum Projekt erhöht, da Nutzer Probleme erstellen, Pull-Anfragen öffnen usw. 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 Sample 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 diese neue Struktur implementiert werden kann, muss sie von den beratenden Personen genehmigt werden. Das bedeutet, dass sich die Struktur nach der Überprüfung durch die beratenden Personen wahrscheinlich ändern wird.

PROJEKTZIELE

Strukturieren Sie die Dokumentation neu.
Aktualisieren Sie die Dokumentation, um sie an die aktuellen Versionen von VLC anzupassen.
Migrieren Sie die Nutzerdokumentation mithilfe von Sphinx und ReadtheDocs zu Gitlab.
Entfernen Sie veraltete Bilder und Informationen.
Überarbeiten Sie die Nutzerdokumentation so, dass sie leichter verständlich ist.
Richten Sie es für die Übersetzung mit Sphinx-Internationalisierung 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 schon immer der Überzeugung, dass das Schreiben von Code, das Lösen von Problemen und das Erstellen von Software ihr volles Potenzial entfalten können, wenn man auch die Fähigkeit besitzt, andere durch Schreiben darüber aufzuklären. Ich persönlich war schon immer von den Bemühungen der VideoLAN-Community fasziniert, kostenlose Softwarelösungen für Multimedia zu entwickeln. In meiner Kindheit war der VLC-Mediaplayer immer die Software, die ich beim Musikhören oder Ansehen von Filmen verwendet habe, weil er sehr laut war und aus so vielen Funktionen bestand. Es ist mir eine Ehre, mit der Community zusammenzuarbeiten, die dazu beigetragen hat, dass meine Kindheit zu einem besonderen Erlebnis wurde.

WARUM bin ich der richtige Ansprechpartner für dieses Projekt?

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

Ich habe in der Vergangenheit Erfahrung mit der Verbesserung der Dokumentation von Organisationen und kann jedes Versionskontrollsystem verwenden, sodass die Ausführung von Befehlen über Gitab kein Problem sein wird. Was mich außerdem antreibt, an Projekten zu arbeiten, die einen Mehrwert für die Menschen schaffen.
Ich glaube, wenn Sie möchten, dass jemand etwas auf die effizienteste Weise tun soll, dokumentieren Sie das. Durch die Dokumentation Ihrer Prozesse stellen Sie Effizienz, Einheitlichkeit und Sicherheit für alle Beteiligten sicher.
Ich kenne die Bedürfnisse von VLC-Nutzenden, weil ich dazu gehöre. Auf diese Weise können Sie die Dokumentation so schreiben, dass alle Nutzenden auf der ganzen Welt sie auf den ersten Blick verstehen.