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:
- luzeal
- Nom du projet:
- Intégration à QubesOS ! Écrivons un guide ouvert et facile à utiliser
- Durée du projet:
- Durée standard (trois mois)
Project description
Intégrez QubesOS !
Je souhaite créer un guide ouvert et des documents associés pour les nouveaux utilisateurs de QubesOS. L'objectif est de présenter QubesOS au profane et de rendre le guide aussi concis et compréhensible que possible, à l'aide d'analogies, d'illustrations et de schémas. Dans un souci de cohérence, nous utiliserons des liens vers des ressources fiables, y compris en priorité celles présentes sur le site Web de QubesOS. Tout sera publié sous une licence ouverte.
Par "contenu autonome", j'entends un contenu qui peut exister indépendamment du site Web, par exemple sous la forme d'un manuel. Il ne correspond pas à la version hors connexion du guide. Dans l'idéal, un autre pipeline de publication du contenu en tant que guide doit être créé, en plus du site Web.
Par "ouvert", j'entends un guide qui sera publié sous licence libre.
Comment procéder
Définir l'audience cible
À ce jour, j'ai l'impression que la catégorie d'utilisateurs ciblée par QubesOS n'est pas bien définie. En quoi 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 les scénarios dans lesquels QubeOS peut s'avérer utile.
Définir correctement les attentes
Il est également important d'avertir les nouveaux utilisateurs que QubesOS nécessite un bon niveau de connaissances IT. L'utilisation de QubesOS a un coût en termes d'usabilité, en particulier si QubesOS est votre système informatique principal. Sur le même jeton, il y a des choses que QubeOS ne fonctionnera pas bien (par nature), telles que l'accélération 3D dans les machines virtuelles. Il est important d'être clair dès le départ, non pas pour dissuader les utilisateurs de l'utiliser, mais pour définir des exceptions pour les utilisateurs potentiels.
Qu'est-ce que QubesOS et qu'est-ce que ce n'est pas ?
Même si QubesOS est un système d'exploitation particulier (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é). Vous pouvez utiliser un diagramme/un tableau simple.
Les spécifications du guide seront définies avec la communauté.
Quelles informations minimales le guide doit-il contenir ? Dans quelle mesure l'installation peut-elle être simplifiée sans sacrifier la sécurité ? Où doit se trouver le seuil ? Existe-t-il une configuration QubesOS minimale viable et sécurisée ? Si ce n'est pas le cas, il peut être défini et défini comme cible du guide.
Licence
Obtenez une licence. Le wiki Archlinux, très respecté, utilise la GNU Free Documentation License 1.3 ou une version ultérieure. Cette licence vous convient-elle ?
Autres projets
Rendre la documentation du site Web plus attrayante
Les notes peuvent être surlignées en rouge ou en jaune afin de les rendre plus faciles à remarquer. Par exemple, vous pouvez utiliser des cases de couleur, comme celles que vous trouverez dans le wiki Archlinux : https://wiki.archlinux.org/index.php/Linux_Containers.
Vous pouvez utiliser des guillemets.
Contenus des liens
Le site Web de documentation contient actuellement de nombreux contenus, mais les éléments individuels ne sont souvent pas liés à d'autres sujets pertinents. Les articles peuvent être reliés entre eux pour améliorer la visibilité.