Cette page contient les détails d'un projet de rédaction technique accepté pour le Google Season of Docs.
Résumé du projet
- Organisation Open Source :
- Qubes OS
- Rédacteur technique :
- luzeal
- Nom du projet :
- Onboard with QubesOS ! Écrivons un guide ouvert et facile à utiliser
- Durée du projet :
- Durée standard (3 mois)
Description du projet
Onboard with QubesOS !
Je souhaite créer un guide ouvert et des ressources associées pour les nouveaux utilisateurs de QubesOS. L'objectif est de présenter QubesOS aux profanes et de rendre le guide aussi concis et compréhensible que possible, en utilisant des analogies, des illustrations et des schémas. Pour le rendre concis, des liens vers des ressources fiables et de confiance seront utilisés, y compris et surtout ceux présents sur le site Web de QubesOS. Tout sera publié sous une licence ouverte.
Par "autonome", j'entends un contenu qui pourrait exister indépendamment du site Web, par exemple sous la forme d'un manuel. Cela n'équivaut pas à la version hors connexion du guide. Idéalement, un autre pipeline de publication du contenu sous forme de guide sera créé, en plus du site Web.
Par "ouvert", j'entends un guide qui sera publié sous une licence ouverte.
Comment procéder
Définir l'audience cible
À ce jour, j'ai l'impression que la catégorie d'utilisateurs à laquelle QubesOS s'adresse n'est pas bien définie. Comment QubesOS peut-il aider les journalistes, les avocats, les analystes de sécurité, les développeurs de logiciels, etc. ? Il serait intéressant de décrire des scénarios dans lesquels QubeOS peut s'avérer utile.
Définir des attentes claires
Il serait également important d'avertir les nouveaux utilisateurs que QubesOS nécessite un bon niveau de connaissances informatiques. L'utilisation de QubesOS a un coût en termes d'ergonomie, en particulier si QubesOS est votre système informatique principal. De même, il y a des choses que QubeOS ne fera pas bien (par conception), comme l'accélération 3D dans les machines virtuelles. Il est important de le préciser dès le début, non pas pour dissuader les gens de l'utiliser, mais pour définir les attentes des utilisateurs potentiels.
Ce qu'est QubesOS et ce qu'il n'est pas
Même si QubesOS est un type spécial de système d'exploitation (une distribution Xen), il serait intéressant de le comparer à d'autres systèmes d'exploitation en fonction de leurs fonctionnalités ou de leur absence (par exemple, Windows utilise de plus en plus la virtualisation et le bac à sable comme mécanismes de sécurité). Un simple schéma ou tableau pourrait être utilisé.
Les spécifications du guide seront définies avec la communauté.
Quelles sont les informations minimales que le guide doit contenir ? Dans quelle mesure l'installation peut-elle être simplifiée sans sacrifier la sécurité ? Où doit se situer le seuil ? Existe-t-il une configuration QubesOS minimale viable et sécurisée ? Si ce n'est pas le cas, elle pourrait être définie et définie comme objectif du guide.
Licence
Choisissez une licence. Le wiki Archlinux, très respecté, utilise la licence GNU Free Documentation 1.3 ou une version ultérieure. Cette licence serait-elle adaptée ?
Autres projets
Rendre la documentation du site Web plus attrayante visuellement
Les notes peuvent être mises en évidence en rouge ou en jaune pour les rendre plus visibles. Par exemple, des cases de couleur peuvent être utilisées, comme celles du wiki Archlinux. https://wiki.archlinux.org/index.php/Linux_Containers.
Des citations en retrait peuvent être utilisées.
Lier le contenu
Le site Web de documentation contient actuellement beaucoup de contenu, mais les éléments individuels ne sont souvent pas liés à d'autres sujets pertinents. Les articles peuvent être liés les uns aux autres pour améliorer la visibilité.