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 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 (3 mois)

Project description

EXTRAIT

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 empêche les utilisateurs d'abandonner un produit lorsqu'ils rencontrent un problème. Qubes compte des milliers d'utilisateurs quotidiens dans le monde, dont beaucoup seront confrontés à un problème à un moment donné et bénéficieront d'un guide de dépannage.

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

À l'heure actuelle, les guides de dépannage QubesOS sont disséminés sur de nombreuses pages et parfois incomplets, ce qui conduit à publier à plusieurs reprises les mêmes instructions pour aider les utilisateurs à diagnostiquer des problèmes. Les guides disponibles manquent d'une mise en page d'action de symptôme, ce qui rend difficile pour un utilisateur de faire correspondre un problème à sa solution. De plus, certains problèmes ont été mentionnés à plusieurs reprises sur les réseaux sociaux (Reddit), sur la page des problèmes GitHub de Qubes et sur le #qubes-users forum, mais qui n'ont pas été documentés dans le guide de dépannage actuel.

POURQUOI MON GUIDE DE DÉPANNAGE PROPOSÉ EST-IL UNE AMÉLIORATION PAR RAPPORT À L'ACTUEL ?

Le guide de dépannage que je propose sera complet et structuré de manière à garantir l'exactitude et la facilité de navigation. Le guide présentera des instructions concises qui expliquent comment résoudre un problème d'une manière étape par étape. Elle comprendra une mise en page de l'action en cas de symptôme, où un problème sera énoncé, suivi d'une solution recommandée pour résoudre ce problème. Les solutions de dépannage seront optimisées pour les moteurs de recherche et rédigées de manière à tenir compte des problèmes recherchés par les utilisateurs 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 RÉSOLUTION DES PROBLÈMES PROPOSÉ ET DÉLAI

J'ai créé une proposition de structure pour le guide de dépannage Qubes OS. Vous le trouverez ici: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. La mise en page est accompagnée d'un délai estimé pendant lequel chaque section de dépannage sera écrite. Cette mise en page sera mise en œuvre après les commentaires 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 proposer une présentation plus compréhensible et consolidée des actions liées aux symptômes.
Réécrivez les solutions de dépannage existantes pour obtenir des instructions détaillées et faciles à suivre.
Ajoutez des captures d'écran si nécessaire.
Installez et essayez Qubes moi-même, et notez tous 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 éventuels dépannages.
Supprimez toute information obsolète du guide existant.
Assurez-vous que les solutions de dépannage sont correctes. Pour le moment, les guides de dépannage existants affichent le message d'erreur suivant : "Il s'agit de documentation tierce non officielle. Le projet Qubes OS ne peut garantir l'exactitude de cette page. Soyez prudent." Cet avertissement ne s'affichera plus une fois que nous aurons vérifié l'exactitude des instructions de dépannage. Leur exactitude sera garantie en testant personnellement les problèmes sur mes PC (si possible) ou en vérifiant en ligne si des utilisateurs ont validé la solution.
Transférez tous les dépannages externes (du forum et de GitHub) vers la page Web officielle de dépannage.
Effectuez des recherches et identifiez d'autres problèmes rencontrés par les utilisateurs de Reddit (r/QubesOS), de Stack Exchange, du groupe Google #qubes-users et de GitHub. J'utiliserai également des outils de recherche de mots clés tels que Keywordtool.io et UberSuggest.com afin de découvrir les questions fréquemment posées sur les moteurs de recherche tels que Google.
Ajoutez une section "Obtenir de l'aide" au cas où le guide de dépannage ne résoudreait pas le problème des utilisateurs. Vous en trouverez un exemple sur la page de dépannage de Fedora: https://docs.fedoraproject.org/en-US/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 crois que l'écriture est l'un de mes meilleurs atouts. Je m'intéresse particulièrement au système d'exploitation Qubes, car il recoupe deux de mes principaux intérêts: la sécurité et la confidentialité. Je suis un utilisateur passionné d'autres produits axés sur la sécurité et la confidentialité, comme DuckDuckGo et Tor. Je n'ai découvert que récemment Qubes OS et je l'adore jusqu'à présent.

POURQUOI JE PENSE ÊTRE LA BONNE personne POUR CE PROJET ?

Je suis passionnée par la sécurité, la confidentialité et la rédaction de documents utiles/de qualité.
Comme j'ai rencontré des problèmes lors de l'installation et de l'utilisation de l'OS Qubes, je peux 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 beaucoup étudié la documentation du système d'exploitation Qubes. Pour comprendre 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 dans le cadre du projet Tor. Mes rôles étaient ceux de l'assistance technique et de la rédaction. Au sein du 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 compréhensibles
Dans le cadre du 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.