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. Elle fournit des informations techniques et non techniques sur un produit ou un service. Elle aide les utilisateurs à apprendre à utiliser un logiciel ou un service. Certaines personnes ne souhaitent pas contacter l'assistance ni attendre une réponse par e-mail si elles n'ont besoin que d'un petit conseil, d'un conseil ou d'une astuce. C’est exactement ce que la documentation utilisateur fait. Elle permet également de réduire les coûts d'assistance, et permet d'identifier l'état de santé du produit et l'équipe de développement.

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. Les gens veulent souvent utiliser ces fonctionnalités, mais ils n'y parviennent pas. La recherche d'un blog ou d'une vidéo pour y parvenir demande beaucoup de temps et de patience, mais les informations obtenues ne sont pas authentiques. 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 en cours offrira 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 peu d'informations sur la dernière version de VLC. De plus, la navigation est complexe. Il n'existe aucune option visible permettant de lire la documentation dans une autre langue que l'anglais. Il ne contient aucune description des caractéristiques.

ANALYSE

-> Pour l'instant, la documentation actuelle est obsolète et doit être rédigée d'une nouvelle manière, et utiliser une autre plate-forme et des 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 est déconseillé 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 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 voulons donc leur simplifier la tâche.

-> La plupart des utilisateurs essaient d'obtenir des informations via leur smartphone et se servent d'un ordinateur de bureau ou d'un autre appareil pour se reposer. La documentation doit donc être facilement adaptable à chaque taille d'écran. Et ne crée aucune confusion sur la navigation.

-> Toutes les fonctionnalités de la version de bureau ne sont pas disponibles sur le port Android et, le cas échéant, 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 récent et en cours de développement. À part cela, bien que les appareils mobiles deviennent de plus en plus puissants, le type de fonctionnalité que nous pouvons intégrer est clairement limité en raison de la demande de l'utilisateur final. Une fonctionnalité que personne n'utilise représente un gaspillage de ressources de développement. Il n'est donc pas recommandé de converser les deux documents sur la base des caractéristiques.

EN FONCTION DES ANALYSES CI-DESSUS, VOUS PROPOSEZ CE QUI SUIT. 1. Pour le moment, la documentation utilisateur pour ordinateur utilise le générateur de documentation Sphinx et le thème "Lire le thème Docs". L'utiliser pour le port Android nous aidera à : -> Fusion facile des deux documents. -> Elle est optimisée pour toutes les tailles d'écran. -> Expérience fluide lors de la navigation vers la documentation utilisateur Android via la documentation de bureau

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

   More

   |__Paramètres

   | |__Bibliothèque multimédia

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

   : -> Cette approche facilite l'accès, car les utilisateurs pourront accéder facilement à la section 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 simple et non technique, puis mettre en avant ou étiqueter les parties techniques de la même caractéristique, le cas échéant, juste en dessous. Cela peut donner lieu à des répétitions, mais cela garantira une expérience fluide aux personnes n'ayant pas la majorité des techniciens. Cela vous aidera également à l'avenir en améliorant la gestion. Étant donné que l'application atteindra un état de saturation, il est peu probable que l'interface utilisateur relative change beaucoup. Par conséquent, si une nouvelle fonctionnalité est ajoutée ou supprimée, nous pouvons 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 étiquetée, d'une description de la fonctionnalité, d'éléments 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 permettra de fusionner les deux documents en seulement quelques étapes, sans que cela n'affecte la documentation actuelle ni ne soit affectée pendant le développement. Je propose de placer l'intégralité de cette documentation dans la section Android de la documentation pour ordinateur de bureau une fois qu'elle aura été 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 utilisateur 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 traduite, nous pouvons proposer des options sous Windows/MacOS/Linux, ou Android ou iOS. Cela se traduira par une documentation utilisateur joliment 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. Cette configuration est également facile à gérer puisqu'il n'est plus nécessaire de conserver la documentation de l'utilisateur pour chaque port.

POURQUOI SONT-ELLES PERSONNELLES 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 trucs techniques sur Quora, Stack Overflow et diverses autres plateformes. Je sais expliquer les choses de 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 il n'y a pas d'aide disponible. J'utilise VLC sur ordinateur et sur mobile depuis de nombreuses années et je sais à quels problèmes un utilisateur peut rencontrer. En mettant à profit toutes mes connaissances et mon expérience, je peux vous assurer une excellente documentation.