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:
- Le projet FreeBSD
- Rédacteur technique:
- quafféine
- Nom du projet:
- Créer un chapitre dans le manuel sur le vin
- Durée du projet:
- Durée standard (3 mois)
Project description
Dans le cadre de cette initiative, je pourrais produire un chapitre détaillé et long du manuel FreeBSD concernant l'installation, l'utilisation et le dépannage de WINE (www.winehq.org) sur FreeBSD. Sauf indication contraire, je compte passer 4 à 8 heures chaque semaine sur les éléments ci-dessous.
*** Engagement communautaire
Si je suis sélectionné, je passerais la période de liaison communautaire à me familiariser avec les processus et l'infrastructure de documentation du projet FreeBSD. J'ai toujours été impressionné par la documentation cohérente du projet et je contactais les membres de l'équipe du projet concernant leur flux de travail. J'ai aussi rejoint et parcouru des forums destinés aux utilisateurs pour avoir une idée de ce qui aiderait les utilisateurs de FreeBSD en ce qui concerne la documentation en général, et aider à travailler avec WINE sur FreeBSD en particulier.
Au cours de cette période, je passerais un peu de temps à découvrir la chaîne d'outils de la documentation du projet. Cela me permettra de me lancer dès les premières semaines du projet si je suis sélectionné.
*** Semaine 1 (14/09-19): installations de test et dépannage
Je passerais la première semaine de la phase de développement de documents à effectuer une installation de simulation de WINE sur la version stable actuelle de FreeBSD, ainsi qu'à installer et exécuter diverses applications Windows, allant des utilitaires simples aux applications plus complexes. C'est une approche que j'ai adoptée dans un article similaire que j'ai fait sur ReactOS pour MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), mais j'en profite de la première semaine pour examiner un plus grand nombre de programmes.
D'après mon expérience, ce type de temps d'attente est utile pour identifier (et résoudre) les problèmes généraux. De cette façon, je pourrais avoir les solutions en main lorsqu'il sera temps de rédiger les sections pertinentes ou, au moins, d'avoir des demandes d'assistance auprès des canaux appropriés.
Objectif de la semaine:disposer d'un aperçu des chapitres d'installation et des détails nécessaires concernant la résolution des problèmes d'installation courants.
*** Semaine 2 (21/09-25): documentation de l'installation de WINE
Au cours de la semaine 2, je rédigerais la ou les sections illustrant l'installation de WINE selon des méthodes populaires, notamment:
- À partir de la source via le système de ports
- Via des packages binaires à l'aide de dépôts principaux
- Utiliser les gestionnaires de packages IUG disponibles, le cas échéant
- À partir d'autres dépôts, tels que FreshPorts (et pourquoi un utilisateur peut vouloir le faire)
Dans cette section, il est important de parler des installations simultanées, 32 ou 64 bits, afin de mettre en évidence les étapes supplémentaires requises par l'exécution de programmes pour différentes architectures.
Objectif de la semaine:ébauche soignée des sections décrivant l'installation de WINE sur FreeBSD. Cette "ébauche peaufinée" doit contenir un texte presque final (en attente de révision et d'examen des commentaires) et des espaces réservés pour les captures d'écran (si elles ne sont pas les captures d'écran elles-mêmes).
*** Semaine 3 (28/09-02/10): Lancez votre premier programme WINE sur FreeBSD
Une fois le sous-système WINE installé, la section suivante détaille l'installation et l'exécution de certains programmes initiaux. Ces outils se concentrent très probablement sur des utilitaires simples et autonomes, tels que l'Open Source Notepad++. L'objectif est de permettre aux utilisateurs de télécharger rapidement une application, de l'installer et de voir qu'elle fonctionne en toute simplicité.
Cette section est importante pour démontrer aux utilisateurs que certaines, voire un grand nombre d'applications Windows peuvent effectivement s'exécuter sous FreeBSD, ce qui en fait un choix viable pour l'informatique quotidienne.
Objectif de la semaine:identifier un petit nombre de programmes qui s'installent correctement et (en grande partie) parfaitement opérationnels, et une version préliminaire soignée des sections qui illustrent leur installation.
*** Semaine 4 (5/10-9): Présentation et concepts de WINE
La fin de la section précédente fait allusion à la nécessité d'effectuer quelques réglages et personnalisations pour que certaines applications fonctionnent sur WINE. À ce stade, une présentation du sous-système WINE est utile pour fournir du contexte. Ces sections examinent ce qui est fourni avec le système WINE, comment celui-ci interagit avec FreeBSD et où un utilisateur peut commencer à chercher une meilleure compréhension du système ou à résoudre des problèmes.
Il est important de noter que cette section ne vise pas à dupliquer les ressources existantes, mais plutôt à présenter un aperçu organisé qui renvoie vers d'autres sources (faciles à assimiler) pour plus d'informations.
Objectif de la semaine:ébauche soignée des sections présentant le sous-système WINE aux utilisateurs.
*** Semaine 5 (12/10-16): configuration WINE sur FreeBSD
Cette ou ces sections approfondissent la configuration réelle de WINE, à commencer par les modifications/réglages généraux spécifiques à FreeBSD. Ils illustrent également l'utilisation de dossiers $WINEPREFIX, qui peuvent être utilisés pour personnaliser l'environnement WINE pour une application particulière. Comme il existe des ressources existantes qui expliquent ce concept en profondeur, cette section ne fournira qu'une introduction assez détaillée avant de créer un lien vers elles.
Objectifs de la semaine:ébauche soignée des sections indiquant où, comment et dans quelles circonstances une configuration approfondie de WINE est nécessaire.
*** Semaine 6 (19/10-23): IUG WINE sur FreeBSD
Dans la mesure où la configuration de WINE pour exécuter un programme donné peut être un exercice complexe et chronophage, des outils d'assistance existent pour faciliter ce processus. Cette ou ces sections offrent un aperçu de l'installation et de l'utilisation de certaines des options qui existent sur FreeBSD, y compris:
- WINECfg
- vœux
- Playonbsd
- autres disponibles
Objectif de la semaine:proposer des brouillons de sections soignés avec des instructions sur l'installation et l'utilisation d'un maximum d'applications d'assistance IUG WINE les plus populaires possible.
*** Semaine 7 (26-30/10): Questions fréquentes sur WINE/FreeBSD (recherche)
Certaines des informations les plus précieuses concernant des applications techniques complexes telles que WINE se trouvent dans l'interaction entre des utilisateurs qui essaient de résoudre des problèmes particuliers et des experts fournissant des réponses. Les utilisateurs gagneront beaucoup de temps si certaines de ces questions fréquentes, en particulier celles qui sont connues pour avoir une incidence sur les utilisateurs de FreeBSD, sont regroupées en un seul endroit.
Ces sections visent à répondre à ce besoin. Je me contenterais, cette semaine, d'étudier les types de problèmes que les utilisateurs de FreeBSD rencontrent généralement avec WINE, ainsi que de chercher et (dans la mesure du possible) les réponses à ces questions. Les lecteurs de ce chapitre du Manuel auront ainsi beaucoup plus de chances de résoudre rapidement un problème particulier.
Cette ou ces sections comprennent également une liste de ressources sur les endroits où chercher les réponses qu'elle n'a pas fournies.
Objectif de la semaine:version(s) soignée(s) du brouillon contenant les problèmes WINE les plus courants, rencontrés par les utilisateurs FreeBSD ou en général, et liens/notes concernant leurs solutions. Notez que même si les travaux de cette semaine n'ont pas d'ébauche de projet, il faudra probablement plus de temps pour trouver et concilier les problèmes courants, ainsi que pour identifier leurs solutions. Je m'attendrais à consacrer plus de 8 à 10 heures à cette recherche.
*** Semaine 8 (2-6): questions fréquentes sur WINE/FreeBSD
Cette semaine sera consacrée à la synthèse de la recherche de la semaine 7 pour créer la ou les sections sur les questions fréquentes/les problèmes de dépannage courants (en établissant des liens vers des solutions si approprié).
Objectif de la semaine:une ébauche soignée des sections répertoriant les questions fréquentes/les problèmes fréquemment rencontrés, ainsi que des instructions détaillées pour les résoudre.
*** Semaine 9 (9-13/11): administration WINE multi-utilisateur
Cette ou ces sections fournissent des conseils aux administrateurs qui souhaitent déployer WINE dans un scénario multi-utilisateur. Cela comprendrait non seulement les meilleures pratiques de partage du sous-système lui-même entre plusieurs utilisateurs, mais également en ce qui concerne les applications Windows déployées dans WINE.
Objectif de la semaine:un brouillon soigné de la ou des sections détaillant les conseils et les bonnes pratiques permettant aux administrateurs FreeBSD de déployer des applications WINE et WINE auprès de plusieurs utilisateurs.
*** Semaine 10 (16/11-20): annexes, examen des commentaires et administration
Bien que je m'efforce de mettre en œuvre les commentaires reçus des mentors et d'autres évaluateurs tout au long du processus de rédaction, cette semaine me laisserait du temps pour une réorganisation/réécriture plus approfondie si nécessaire.
En outre, je rédigerai toutes les informations d'administration nécessaires pour ce chapitre du manuel (première partie, index, etc.) au cours de cette période, et je ferai mon possible pour vous aider à trouver des informations complémentaires sur WINE (par exemple, en utilisant la version Linux de WINE via une compatibilité binaire, DOSBox pour les anciens jeux et programmes, etc.).
Objectif de la semaine:une ébauche soignée de l'ensemble du chapitre du manuel, y compris toutes les autres sections.
*** Semaine 11 (23/11-27): Finalisation des chapitres du manuel
Je prévois de consacrer cette semaine à la relecture de tout le texte, à la vérification des images et au test des différentes sorties (HTML, PDF, etc.) si nécessaire. Cette semaine permettra également des mises à jour au cas où l'un des logiciels ci-dessus (de FreeBSD lui-même à WINE ou ses assistants) serait mis à niveau dans le temps depuis sa rédaction initiale.
Objectif de la semaine:version finale du chapitre du manuel, incluant toutes les mises à jour requises.
*** Semaine 12 (30/11-05/12): Finalisation du projet
En accord avec les mentors du projet, je consultais le chapitre du manuel sur le contrôle des sources, j'élaborais le rapport du projet et je soumettrait le projet comme terminé.