Projet VLC

Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.

Résumé du projet

Organisation Open Source:

VLC

Rédacteur technique:

Avii

Nom du projet:

Créer la documentation utilisateur VLC pour un port mobile (Android)

Durée du projet:

Durée standard (3 mois)

Project description

EXTRAIT

La documentation utilisateur fait office de système d'assistance statique pour aider les utilisateurs finaux. Elles fournissent des informations techniques et non techniques sur un produit ou un service. Elle aide les utilisateurs à apprendre à utiliser un logiciel ou un service. Toutes les personnes ne veulent pas contacter l'assistance ni attendre une réponse par e-mail si elles n'ont besoin que d'un peu d'orientation, de conseils ou d'astuces. La documentation utilisateur fait simplement cela. Elle permet également de réduire les coûts d'assistance, et est une identité de l'état du produit et de l'équipe de développeurs.

VLC pour Android a été téléchargé plus de 100 millions de fois rien que sur le Google Play Store. VLC offre de nombreuses fonctionnalités pour ses ports mobiles, de la lecture audio-vidéo au flux réseau. Souvent, les internautes veulent profiter de ces fonctionnalités utiles, mais ce n'est pas possible. Rechercher un blog ou une vidéo sur ce sujet demande beaucoup de temps et de patience, mais l'authenticité des informations obtenues n'est pas garantie. Actuellement, VLC héberge la documentation utilisateur de VLC pour Android sur la page wiki et fournit peu ou pas de description de ces fonctionnalités. En outre, les pages wiki ont été mises à jour pour la dernière fois en mars 2019. Le projet actuel fournit une nouvelle documentation utilisateur avec un design moderne et une plus grande facilité d'utilisation du port Android.

SITUATION ACTUELLE

Les pages wiki sont complètement obsolètes et contiennent très moins d'informations sur la dernière version de VLC. De plus, ils ne sont pas faciles à parcourir. Il n'existe aucune option visible permettant de lire la documentation dans une autre langue que l'anglais. Il ne contient aucune description des fonctionnalités.

ANALYSE

-> Pour l'instant, la documentation actuelle est obsolète et doit être écrite différemment, et à l'aide d'une plate-forme et d'outils différents.

-> La plupart des utilisateurs Android ont peu ou pas de connaissances techniques. Mais certaines personnes ont besoin d'informations plus techniques sur une fonctionnalité. Il n'est pas recommandé de rédiger et de gérer deux documents distincts pour chacun des objectifs ci-dessus. Ou même, dans la même documentation, diviser une fonctionnalité selon des critères techniques et non techniques crée une confusion supplémentaire. Là encore, la plupart des utilisateurs sont habitués à l'interface utilisateur qu'ils voient ou aux fonctionnalités qu'ils utilisent. Il n'est donc pas facile pour chacun de décider si quelque chose est technique ou non. Nous voudrions donc leur simplifier la tâche.

-> La plupart des utilisateurs essaient d'obtenir des informations via leur smartphone et les autres vont sur un ordinateur ou un autre appareil. La documentation doit donc pouvoir s'adapter facilement à chaque taille d'écran. Et ne crée aucune confusion sur la navigation.

-> Toutes les fonctionnalités de la version classique ne sont pas disponibles sur le port Android. Si elles sont disponibles, elles ne fonctionnent pas de la même manière sur les deux ports. Cela est dû au fait que l'application de bureau est en cours de développement depuis beaucoup plus longtemps et qu'elle a atteint une sorte de saturation. En revanche, le port mobile est relativement nouveau et continue d'évoluer. En dehors de cela, bien que les appareils mobiles deviennent si puissants de nos jours, il existe une restriction évidente sur le type de fonctionnalité que nous pouvons intégrer, principalement en raison de la demande de l'utilisateur final. Le fait de disposer d'une fonctionnalité que personne n'utilise représente un gaspillage de ressources de développement. Il n'est donc pas recommandé de traiter ces deux documents sur la base des caractéristiques.

EN FONCTION DES ANALYSES CI-DESSUS, JE PROPOSE CE QUI SUIT. 1. À l'heure actuelle, la documentation utilisateur de bureau utilise le générateur de documentation Sphinx et lire le thème Docs. L'utiliser pour le port Android nous aidera à : -> Fusionner facilement les deux documents. -> Elle est optimisée pour toutes les tailles d'écran. -> Expérience fluide lorsque vous accédez à la documentation utilisateur Android via la documentation sur ordinateur.

1. Séparer les chapitres, les sections et les sous-sections en fonction de leur position relative dans l'application. Par exemple, accédez au mode Arrière-plan/PIP sous Plus -> Paramètres -> Vidéo. La structure des chapitres sera donc

   More

   |__Paramètres

   | |__Bibliothèque multimédia

   | |__Vidéo -->Mode arrière-plan/PIP

   : -> Cette approche améliore la facilité d'accès, car les utilisateurs pourront accéder facilement à la partie où ils ont besoin d'aide en la comparant à l'emplacement relatif dans l'application. Pour chacune des fonctionnalités, nous pouvons séparer les parties techniques et non techniques. Nous devons d'abord rédiger une description facile d'un point de vue technique, puis mettre en avant les parties techniques de la même fonctionnalité, le cas échéant, juste en dessous. Cela peut donner lieu à des répétitions, mais cela garantira une expérience fluide à la majorité non technique. Cela permettra également à l'avenir d'améliorer la facilité de gestion. Comme l'application atteindra un état de saturation, il est peu probable que l'interface utilisateur relative change grandement. Par conséquent, si une nouvelle fonctionnalité est ajoutée ou supprimée, nous pourrons simplement refactoriser la section. Si l'ensemble de l'interface utilisateur est modifié, nous pouvons réorganiser les sections/chapitres ou restructurer l'ensemble du document. Dans les deux cas, nous devons modifier l'ensemble de la documentation, car la capture d'écran doit être remplacée pour correspondre à l'UI actuelle. Une démonstration fonctionnelle est hébergée ici : https://avinal.gitlab.io/vlc-android-docs/

2. Chaque section de la documentation se compose d'une capture d'écran libellée , d'une description de la fonctionnalité, de parties plus techniques (le cas échéant) et de conseils et astuces la concernant.

-> Le développement indépendant de cette documentation utilisateur à partir de l'ordinateur de bureau nous aidera à fusionner les deux documentations en seulement quelques étapes, sans que cela n'affecte la documentation actuelle ni ne soit affectée par celle-ci pendant le développement. Je propose de placer toute cette documentation dans la section Android de la documentation pour ordinateur de bureau une fois qu'elle est développée, puis de créer un lien permanent pour la documentation VLC pour Android.

-> D'autres améliorations peuvent inclure la refonte de la page d'accueil de la documentation pour les utilisateurs de bureau pour permettre aux utilisateurs de choisir directement leur système d'exploitation préféré, puis la redirection vers la documentation de l'OS choisi. Étant donné que la documentation utilisateur de Windows, macOS et Linux VLC est déjà bien conçue et échange, nous pouvons proposer des options entre Windows/macOS/Linux ou Android ou iOS. Vous obtiendrez ainsi une documentation utilisateur bien séparée, mais unifiée, avec un seul lien à utiliser pour tous les ports.

POURQUOI MA DOCUMENTATION UTILISATEUR PROPOSÉE EST-elle MIEUX ? Cette documentation utilisateur proposée est structurée en fonction des modèles courants suivis par l'utilisateur final pour obtenir de l'aide. La documentation réunit toutes les fonctionnalités requises, telles que la simplicité, la clarté, l'aspect général et les connaissances technologiques pour optimiser la facilité d'utilisation et l'expérience utilisateur. Il est également facile de gérer cela puisqu'il n'est plus nécessaire de conserver la documentation utilisateur individuelle pour chaque port.

POURQUOI SUIS-JE LA BONNE PERSONNE POUR CE PROJET ? -> Je rédige des codes depuis deux ans maintenant et je dois souvent consulter la documentation de l'API pour certaines bibliothèques ou certains logiciels, ou même documenter mon propre code. Je sais donc exactement ce que les gens veulent voir dans la documentation, à quel problème ils sont confrontés et comment ils abordent pour obtenir de l'aide. je pourrai utiliser la même expérience pour écrire une documentation cohérente et facilement lisible.

-> J'ai travaillé activement à la rédaction de sujets techniques sur Quora, Stack Overflow et sur plusieurs autres plateformes. Je sais expliquer les choses d'une manière accrocheuse et facilement compréhensible.

-> VLC pour Android est un outil puissant et très connu, mais la plupart de ses fonctionnalités sont inconnues ou aucune aide n'est disponible. J'utilise VLC sur ordinateur et sur des plates-formes mobiles depuis de nombreuses années maintenant, et je sais à quels problèmes un utilisateur peut rencontrer. En utilisant toutes mes connaissances et mon expérience, je peux vous assurer une excellente documentation.