Cette page a été traduite par l'API Cloud Translation.

Projet d'OS Qubes

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

Résumé du projet

Organisation Open Source:: Qubes OS
Rédacteur technique:: c1e0
Nom du projet:: Regrouper les guides de dépannage
Durée du projet:: Durée standard (trois mois)

Project description

ABSTRACT

Un guide de dépannage est conçu pour aider les utilisateurs finaux à résoudre les problèmes rencontrés lors de l'utilisation d'un produit ou d'un service. Un bon guide de dépannage est important, car il aide les utilisateurs en cas de problème. Elle évite aux utilisateurs d'abandonner un produit lorsqu'ils rencontrent un problème. Qubes compte des milliers d'utilisateurs quotidiens dans le monde entier, dont beaucoup rencontreront un problème à un moment donné et auront besoin d'un guide de dépannage.

ÉTAT ACTUEL DU GUIDE DE RÉSOLUTION DES PROBLÈMES

À l'heure actuelle, les guides de dépannage de QubesOS sont dispersés sur de nombreuses pages et sont parfois incomplets. Par conséquent, nous publions à plusieurs reprises les mêmes instructions pour aider les utilisateurs à diagnostiquer les problèmes. Les guides disponibles ne comportent pas de mise en page symptome-action, ce qui rend difficile pour l'utilisateur de faire correspondre un problème à sa solution. Par ailleurs, certains problèmes ont été mentionnés à plusieurs reprises sur les réseaux sociaux (Reddit), sur la page dédiée aux problèmes GitHub de Qubes et sur le forum #qubes-users, mais ils n'ont pas été documentés dans le guide de dépannage actuel.

POURQUOI MON GUIDE DE DÉPANNAGE PROPOSÉ EST-IL AMÉLIORÉ PAR RAPPORT À CE QUI EST ACTUEL ?

Le guide de dépannage que je propose sera complet et structuré pour assurer la précision et la facilité de navigation. Le guide présente des instructions concises qui expliquent comment résoudre un problème étape par étape. Il présente une mise en page symptome-action, dans laquelle un problème est décrit, suivi d'une solution recommandée pour le résoudre. Les solutions de dépannage seront optimisées pour les moteurs de recherche et rédigées en tenant compte des problèmes que les utilisateurs recherchent sur les réseaux sociaux et les moteurs de recherche. Tout cela permettra aux utilisateurs de trouver le guide de dépannage officiel via les moteurs de recherche et de trouver rapidement/facilement la solution à leurs problèmes.

STRUCTURE DU GUIDE DE DÉPANNAGE PROPOSÉ ET CALENDRIER

J'ai créé une structure proposée pour le guide de dépannage du système d'exploitation Qubes, disponible ici: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. La mise en page est accompagnée d'une estimation du délai pendant lequel chaque section de dépannage sera rédigée. Cette mise en page sera mise en œuvre après le feedback du mentor. La structure et le calendrier peuvent être modifiés en fonction des commentaires du mentor.

OBJECTIFS DU PROJET

Restructurez le guide de dépannage pour obtenir une mise en page plus claire et consolidée des symptômes et des actions.
Réécrivez les problèmes existants pour obtenir des instructions détaillées faciles à suivre.
Ajoutez des captures d'écran si nécessaire.
Installer et essayer Qubes moi-même, et enregistrer les problèmes rencontrés J'ai trois ordinateurs: un Lenovo ThinkPad, un Dell Latitude et un Acer Aspire. Je vais essayer Qubes sur chacun de ces ordinateurs, en enregistrant les erreurs et en validant les solutions de dépannage.
Supprimez toutes les informations obsolètes du guide existant.
Assurez-vous que les solutions de dépannage sont exactes. À l'heure actuelle, les guides de dépannage existants affichent le message d'erreur ""Ceci est une documentation tierce non officielle. Le projet Qubes OS ne peut pas garantir l'exactitude de cette page. Veuillez faire preuve de prudence."" Cet avertissement sera supprimé une fois que vous aurez vérifié que les instructions de dépannage sont exactes. Leur exactitude sera garantie soit en testant personnellement les solutions de dépannage sur mes PC (si possible), soit en vérifiant en ligne si des utilisateurs ont validé la solution.
Migrez tous les problèmes externes (du forum et de GitHub) vers la page Web de dépannage officielle.
Recherchez et découvrez d'autres problèmes rencontrés par les utilisateurs sur Reddit (r/QubesOS), Stack Exchange, le groupe Google #qubes-users et GitHub. Je vais également utiliser des outils de recherche de mots clés comme Keywordtool.io et UberSuggest.com pour découvrir les questions fréquemment recherchées sur des moteurs de recherche comme Google.
Ajoutez une section "Obtenir de l'aide" si le guide de dépannage ne résout pas le problème de l'utilisateur. Vous trouverez un exemple sur la page de dépannage de Fedora: https://docs.fedoraproject.org/fr/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.

POURQUOI CE PROJET ?

Je suis passionnée par la technologie, en particulier la cybersécurité et la confidentialité. Je pense que l'écriture est l'un de mes points forts. Je suis particulièrement intéressé par l'OS Qubes, car il croise deux de mes centres d'intérêt principaux: la sécurité et la confidentialité. Je suis un utilisateur assidu d'autres produits axés sur la sécurité et la confidentialité, comme DuckDuckGo et Tor. Je n'ai découvert Qubes OS que récemment, et je l'adore.

POURQUOI JE CROYAIS ÊTRE LA PERSONNE ADÉQUATE POUR CE PROJET

Je suis passionné par la sécurité, la confidentialité et la rédaction de documentations de qualité.
J'ai rencontré des problèmes lors de l'installation et de l'utilisation de Qubes OS. Je pourrai ainsi mieux les décrire dans les instructions de dépannage.
Au cours du mois dernier, j'ai étudié les aspects techniques du système d'exploitation Qubes. J'ai également étudié de manière approfondie la documentation de l'OS Qubes. Pour me familiariser avec le processus de modification de la documentation, j'ai créé une demande d'extraction (https://github.com/QubesOS/qubes-doc/pull/1005/files).
J'ai récemment effectué un stage au sein du projet Tor. Mes fonctions étaient l'assistance technique et la rédaction. Lorsque j'étais au centre d'assistance, j'ai reçu des centaines de questions d'utilisateurs qui rencontraient des difficultés lors de l'installation ou de l'utilisation du navigateur Tor. En aidant ces utilisateurs à résoudre leurs problèmes, j'ai appris à rédiger des instructions de dépannage concises et claires.
Lorsque j'ai travaillé au projet Tor, j'ai également rédigé de la documentation technique à l'aide de Markdown. J'ai utilisé Git, GitHub et GitLab pour le contrôle des versions.