VLC-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:
VLC (VLC)
Technischer Redakteur:
Avii
Projektname:
VLC-Nutzerdokumentation für einen mobilen Port erstellen (Android)
Projektdauer:
Standarddauer (3 Monate)

Projektbeschreibung

Abstrakt

Die Nutzerdokumentation wird als statisches Supportsystem verwendet, um Endnutzer zu unterstützen. Sie liefern sowohl technische als auch nicht-technische Informationen zu einem Produkt oder Dienst. Es hilft Nutzenden, den Umgang mit Software oder Diensten zu erlernen. Nicht jeder möchte den Support kontaktieren oder auf eine E-Mail-Antwort warten, wenn er nur eine Anleitung, Tipps oder Tricks benötigt. In der Nutzerdokumentation ist das ganz einfach. Es senkt auch die Supportkosten und ist eine Identität des Produkts und des Entwicklerteams.

VLC für Android wurde allein aus dem Google Play Store über 100 Millionen Mal heruntergeladen. VLC bietet viele Funktionen für seine mobilen Ports, von der Audio-/Video-Wiedergabe bis hin zum Netzwerk-Stream. Viele Nutzer möchten diese großartigen Funktionen nutzen, können das aber nicht. Die Suche nach einem Blog oder zufälligen Videos dazu erfordert viel Zeit und Geduld. Dennoch gibt es keine Authentizität der Informationen. Derzeit hostet VLC die Nutzerdokumentation VLC für Android auf der Wiki-Seite und bietet nur wenige oder keine Beschreibungen dieser Funktionen. Außerdem wurden die Wiki-Seiten zuletzt im März 2019 aktualisiert. Im Rahmen des aktuellen Projekts wird eine neue Nutzerdokumentation in einem modernen Design und einer einfacheren Verwendung des Android-Ports bereitgestellt.

AKTUELLE SITUATION

Die Wiki-Seiten sind vollständig veraltet und enthalten nur sehr wenige Informationen zur neuesten VLC-Version. Außerdem ist die Navigation nicht einfach. Es gibt keine sichtbare Option, die Dokumentation in einer anderen Sprache als Englisch zu lesen. Sie enthält keine Merkmalsbeschreibungen.

ANALYSE

-> Die aktuelle Dokumentation ist veraltet und muss auf neue Art und Weise mit einer anderen Plattform und anderen Tools geschrieben werden.

-> Die meisten Android-Nutzer haben wenig oder gar kein technisches Wissen. Es gibt jedoch Personen, die mehr technische Informationen zu einer Funktion benötigen. Es ist keine gute Idee, für jeden der oben genannten Zwecke zwei separate Dokumentationen zu schreiben und zu pflegen. Auch die Trennung einer Funktion nach technischen und nichttechnischen Aspekten kann für zusätzliche Verwirrung sorgen. Auch hier sind die meisten Nutzenden an die angezeigte Benutzeroberfläche oder die von ihnen verwendeten Funktionen gewöhnt. Daher kann nicht jeder leicht entscheiden, ob etwas technisch oder nicht-technisch ist. Das sollten wir für sie vereinfachen.

-> Die meisten Nutzer versuchen, Informationen über ihr Smartphone zu erhalten und sich stattdessen über einen Desktop-Computer oder andere Geräte zu informieren. Daher sollte sich die Dokumentation problemlos an jede Bildschirmgröße anpassen lassen. Die Navigation soll nicht verwirrend sein.

-> Nicht alle Funktionen der Desktop-Version sind über den Android-Port verfügbar und funktionieren nicht auf beiden Ports, falls verfügbar. Das liegt daran, dass sich Desktop-Anwendungen schon viel länger in der Entwicklung befinden und eine gewisse Sättigung erreicht haben, während der mobile Port im Gegensatz dazu noch relativ neu ist und noch in der Entwicklung ist. Abgesehen davon gibt es, obwohl Mobilgeräte heutzutage so leistungsfähig sind, eine offensichtliche Einschränkung hinsichtlich der Art von Funktionen, die wir integrieren können. Dies liegt vor allem an den Anforderungen der Endnutzer. Eine Funktion zu haben, die nicht verwendet wird, ist eine Verschwendung von Entwicklungsressourcen. Daher wird nicht empfohlen, beide Dokumentationen auf der Grundlage der Funktionen zu verwenden.

Basierend auf der oben genannten ANALYSE schlage ich Folgendes vor. 1. Derzeit werden für die Desktop-Nutzerdokumentation der Sphinx-Dokumentationsgenerator und das Design „Dokumente lesen“ verwendet. Die Verwendung desselben für den Android-Port hilft uns auf folgende Weise: -> Einfache Zusammenführung beider Dokumentation. -> Sie ist für alle Bildschirmgrößen optimiert. -> Nahtloser Zugriff auf die Android-Nutzerdokumentation über die Desktop-Dokumentation

  1. Kapitel, Abschnitte und Unterabschnitte nach ihrer relativen Position in der Anwendung trennen. Beispiel: Der Hintergrund-/BiB-Modus befindet sich unter „Mehr“ -> „Einstellungen“->„Video“. Die Kapitelstruktur ist also
    Mehr
    |__Einstellungen
    | |__Mediathek
    | |__Video -->Hintergrund/BiB-Modus
    : -> Dieser Ansatz erleichtert den Zugriff, da Nutzer durch einen Vergleich mit der relativen Position in der App leichter zu dem Teil navigieren können, bei dem sie Hilfe benötigen. Für jede der Funktionen können wir die technischen und nicht technischen Teile weiter unterteilen. Zunächst verfassen wir eine einfache Beschreibung ohne technischen Hintergrund und heben dann ggf. technische Teile derselben Funktion direkt darunter hervor oder beschriften sie. Dies kann zu einigen Wiederholungen führen, sorgt aber für ein reibungsloses Erlebnis der nichttechnischen Mehrheit. Dies wird auch in Zukunft hilfreich sein, da die Wartbarkeit verbessert wird. Da die Anwendung die Sättigung erreicht, ändert sich die relative Benutzeroberfläche wahrscheinlich nicht viel. Wenn also in Zukunft eine neue Funktion hinzugefügt oder entfernt wird, können wir den Abschnitt einfach refaktorieren. Falls die gesamte Benutzeroberfläche geändert wird, können wir die Abschnitte/Kapitel neu anordnen oder das gesamte Dokument neu strukturieren. In beiden Fällen müssen wir die gesamte Dokumentation ändern, da der Screenshot ersetzt werden muss, um der aktuellen Benutzeroberfläche zu entsprechen. Eine funktionierende Demo finden Sie hier : https://avinal.gitlab.io/vlc-android-docs/

  2. Jeder Abschnitt der Dokumentation muss aus einem beschrifteten Screenshot , einer Beschreibung der Funktion, einem ggf. technischen Teil sowie Tipps und Tricks für die Funktion bestehen.

-> Durch die unabhängige Entwicklung dieser Nutzerdokumentation über den Desktop können wir beide Dokumentationen in nur wenigen Schritten zusammenführen, ohne dass die aktuelle Dokumentation beeinträchtigt wird oder während der Entwicklung davon betroffen ist. Ich schlage vor, die gesamte Dokumentation nach der Entwicklung im Android-Abschnitt der Desktop-Dokumentation zu platzieren und dann einen Permalink für den VLC für Android-Dokumentation zu erstellen.

-> Zu den weiteren Verbesserungen kann eine Umgestaltung der Startseite der Desktop-Nutzerdokumentation gehören, sodass die Nutzer ihr bevorzugtes Betriebssystem direkt auswählen können, und dann eine Weiterleitung zur Dokumentation des jeweiligen Betriebssystems vorzunehmen. Da die Nutzerdokumentation für Windows, MacOS und Linux VLC bereits gut konzipiert ist und gut erörtert wird, stellen wir möglicherweise Optionen zur Auswahl zwischen Windows/MacOS/Linux, Android oder iOS bereit. Dies führt zu einer übersichtlichen, aber einheitlichen Nutzerdokumentation mit nur einem Link, der für alle Ports verwendet werden kann.

WARUM IST MEINE VORGESCHLAGENE NUTZERDOKUMENTATION BESSER? Diese vorgeschlagene Nutzerdokumentation basiert auf den üblichen Mustern, gefolgt vom Endnutzer, um Hilfe zu erhalten. Die Dokumentation kombiniert alle erforderlichen Funktionen wie Einfachheit, Klarheit, Erscheinungsbild und technologisches Wissen, um die Nutzerfreundlichkeit zu maximieren. Dies ist auch einfach zu warten, da nicht mehr für jeden Port eine eigene Nutzerdokumentation verwaltet werden muss.

WARUM BIN ICH DIE RICHTIGE PERSON FÜR DIESES PROJEKT? -> Ich schreibe schon seit zwei Jahren Codes und oft muss ich die API-Dokumentation für bestimmte Bibliotheken oder Software durchgehen oder sogar meinen eigenen Code dokumentieren. Ich weiß also genau, was die Leute in der Dokumentation sehen möchten, welches Problem sie haben und wie sie an Hilfe herangehen. Ich werde in der Lage sein, mit derselben Erfahrung eine einheitliche und leicht lesbare Dokumentation zu erstellen.

-> Ich habe aktiv technische Inhalte auf Quora, Stack Overflow und verschiedenen anderen Plattformen geschrieben. Ich kann Dinge gut verständlich erklären.

-> VLC für Android ist ein leistungsstarkes und sehr bekanntes Tool, aber die meisten Funktionen sind entweder unbekannt oder es gibt keine Hilfe. Ich verwende VLC jetzt seit vielen Jahren sowohl auf Desktop- als auch auf mobilen Plattformen und weiß, welche Probleme Nutzende haben können. Durch die Bemühungen meines Wissens und meiner Erfahrung kann ich eine hervorragende Dokumentation gewährleisten.