Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
Résumé du projet
- Organisation Open Source:
- Projet FreeBSD
- Rédacteur technique:
- quaffeine
- Nom du projet:
- Créer un chapitre du manuel Wine
- Durée du projet:
- Durée standard (trois mois)
Project description
Dans le cadre de cette initiative, je rédigerai un chapitre détaillé du manuel FreeBSD sur l'installation, l'utilisation et le dépannage de WINE (www.winehq.org) sur FreeBSD. J'aimerais consacrer 4 à 8 heures par semaine aux tâches ci-dessous, sauf indication contraire.
*** Renforcement des liens au sein de la communauté
Si cette option est sélectionnée, je passerais la période de création de lien à la communauté à me familiariser avec les processus et l'infrastructure de documentation du projet FreeBSD. J'ai toujours été impressionné par la documentation cohérente fournie par le projet, et je m'engageais avec les membres de l'équipe du projet concernant leur flux de travail. Je rejoindrais également des forums destinés aux utilisateurs et les consulterais pour avoir une idée de ce qui pourrait aider les utilisateurs de FreeBSD en termes de documentation en général et de travail avec WINE sur FreeBSD en particulier.
Pendant cette période, je consacrerais du temps à apprendre la chaîne d'outils de documentation du projet. Cela me permettra de me lancer dans le projet dès les premières semaines si je suis sélectionné.
*** Semaine 1 (14-19/09): Test des installations et dépannage
Je passerais la première semaine de la phase de développement de la documentation à effectuer une installation à blanc de WINE sur la version stable actuelle de FreeBSD, ainsi qu'à installer et exécuter diverses applications Windows, allant d'utilitaires simples à des applications plus complexes. C'est l'approche que j'ai adoptée dans un article similaire que j'ai écrit sur ReactOS pour MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), mais j'ai utilisé la première semaine pour examiner une sélection plus large de programmes.
D'après mon expérience, passer ce temps en amont est utile pour identifier (et résoudre) les problèmes généraux de type ""piège à con"". De cette façon, j'aurais les solutions à portée de main lorsque j'aurai à rédiger les sections concernées, ou au moins les demandes d'assistance envoyées aux canaux appropriés.
Objectif de la semaine:obtenir un aperçu des chapitres sur l'installation et les informations nécessaires pour résoudre les problèmes d'installation courants.
*** Semaine 2 (21-25/09): Documenter l'installation de WINE
Au cours de la deuxième semaine, je rédige en fait les sections illustrant l'installation de WINE à l'aide de méthodes courantes, notamment:
- À partir de la source à l'aide du système de ports ;
- Via des packages binaires à l'aide de dépôts principaux
- Utiliser les gestionnaires de paquets avec interface graphique disponibles, le cas échéant ;
- À partir d'autres dépôts tels que FreshPorts (et pourquoi un utilisateur voudrait-il le faire ?)
Cette section présente les différences entre les architectures 32 bits et 64 bits, ainsi que les installations simultanées, afin de mettre en évidence les étapes supplémentaires requises pour exécuter des programmes de différentes architectures.
Objectif de la semaine:version brouillon soignée de la ou des sections décrivant l'installation de WINE sur FreeBSD. Cette ""ébauche soignée"" doit comporter un texte presque final (en attente de relecture et d'avis d'examen), ainsi que des espaces réservés pour les captures d'écran, voire les captures d'écran elles-mêmes.
*** Semaine 3 (28/09-02/10): Exécuter 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. Ceux-ci se concentreraient très probablement sur des utilitaires simples et autonomes, tels que l’Open Source Notepad++. Le but est de permettre aux utilisateurs de télécharger rapidement une application, de l’installer et de la voir fonctionner en toute simplicité.
Cette section est importante pour montrer aux utilisateurs que certaines/de nombreuses applications Windows peuvent s'exécuter sur 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 proprement et fonctionnent (dans une large mesure) dès la sortie de la boîte, et une version brouillon soignée de la ou des sections illustrant leur installation.
*** Semaine 4 (05-10-09): Présentation et concepts de WINE
La fin de la section précédente fait allusion à la nécessité d'effectuer des réglages et des personnalisations pour que certaines applications fonctionnent sous WINE. À ce stade, une introduction au sous-système WINE est utile pour fournir du contexte. Ces sections examinent ce qui est fourni avec le système WINE, comment il interagit avec FreeBSD et où un utilisateur peut commencer à chercher pour mieux comprendre le système ou résoudre les problèmes.
Notez que cette section n'a pas pour but de dupliquer les ressources existantes, mais plutôt de présenter une vue d'ensemble organisée qui renvoie vers d'autres sources (faciles à assimiler) pour en savoir plus.
Objectif de la semaine:Élaborer une version soignée de la ou des sections présentant le sous-système WINE aux utilisateurs.
*** Semaine 5 (12-16 octobre): Configuration de WINE sur FreeBSD
Ces sections approfondiraient la configuration réelle de WINE, en commençant par les modifications/ajustements globaux spécifiques à FreeBSD. Ils illustrent également l'utilisation des dossiers $WINEPREFIX, qui peuvent être utilisés pour personnaliser l'environnement WINE pour une application particulière. Étant donné que des ressources existent pour expliquer ce concept en détail, cette section ne fournira qu'une introduction modérément détaillée avant de les rediriger vers ces ressources.
Objectifs de la semaine:une version soignée de la ou des sections détaillant où, comment et dans quelles circonstances une configuration approfondie de WINE est requise.
*** Semaine 6 (19/10-23): IUG WINE sur FreeBSD
La configuration de WINE pour exécuter un programme donné peut être un exercice complexe et long. Des outils d'assistance existent pour faciliter ce processus. Cette ou ces sections donnent un aperçu de l'installation et de l'utilisation de certaines des options disponibles sur FreeBSD, y compris:
- WINECfg
- winetricks
- playonbsd
- d'autres, si disponibles
Objectif de la semaine:fournir des sections de brouillon soignées avec des instructions sur l'installation et l'utilisation d'autant d'applications d'assistance WINE GUI les plus populaires que possible.
*** Semaine 7 (26-30 octobre): 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 les interactions entre les utilisateurs qui essaient de résoudre des problèmes particuliers et les experts qui fournissent des réponses. Cela permettrait aux utilisateurs de gagner beaucoup de temps si certaines de ces questions fréquentes, en particulier celles qui affectent les utilisateurs de FreeBSD, étaient rassemblées en un seul endroit.
Cette ou ces sections ont pour but d'atteindre cet objectif. Cette semaine, nous allons nous contenter d'étudier les types de problèmes que les utilisateurs FreeBSD rencontrent fréquemment avec WINE, ainsi que de rechercher et de tester les réponses (dans la mesure du possible). 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 incluent également une liste de ressources permettant de trouver les réponses qui n'ont pas été fournies.
Objectif de la semaine:mettre au point une ou plusieurs sections contenant les problèmes WINE les plus courants, tels que les utilisateurs de FreeBSD ou en général, et des liens/notes sur leurs solutions. Notez que, bien que le travail de cette semaine ne produise pas de version préliminaire, il nécessitera probablement un investissement de temps plus important pour identifier et résoudre les problèmes courants, ainsi que pour trouver des solutions. Je pense que je vais y consacrer entre 8 et 10 heures.
*** Semaine 8 (2-6 nov.): Questions fréquentes sur WINE/FreeBSD
Cette semaine, vous allez synthétiser les recherches de la semaine 7 pour créer les sections sur les questions fréquentes/les problèmes courants de dépannage (en ajoutant des liens vers les solutions, le cas échéant).
Objectif de la semaine:une version soignée de la ou des sections contenant 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 nov.): Administration multi-utilisateur de WINE
Cette ou ces sections fourniraient des conseils aux administrateurs qui souhaitent déployer WINE dans un scénario multi-utilisateur. Il comprendrait non seulement les bonnes pratiques à suivre pour partager le sous-système lui-même entre plusieurs utilisateurs, mais aussi les applications Windows déployées dans WINE.
Objectif de la semaine:une ou plusieurs sections soignées détaillant les conseils et les bonnes pratiques à suivre par les administrateurs FreeBSD pour déployer WINE et les applications basées sur WINE auprès de plusieurs utilisateurs.
*** Semaine 10 (16/11-20): Annexes, commentaires des avis 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.
Pendant cette période, je rédigerai également les éléments administratifs nécessaires à ce chapitre du manuel (éléments préliminaires, index, etc.), ainsi que des ressources complémentaires sur WINE (par exemple, l'utilisation de la version Linux de WINE via la compatibilité binaire, DOSBox pour les anciens jeux/programmes, etc.).
Objectif de la semaine:ébauche de l'intégralité du chapitre du manuel, y compris toutes les autres sections.
*** Semaine 11 (23-27 nov.): finalisation du chapitre du manuel
Je prévois de consacrer cette avant-dernière semaine à la relecture de l'ensemble du texte, à la vérification des images et au test des différentes sorties (HTML, PDF, etc.) si nécessaire. Cette semaine permettra également de mettre à jour le guide au cas où l'un des logiciels ci-dessus (de FreeBSD lui-même à WINE ou ses assistants) serait mis à niveau depuis la rédaction initiale.
Objectif de la semaine:version finale du chapitre du manuel, incluant toutes les mises à jour requises.
*** Semaine 12 (30/11-5/12): Finalisation du projet
En accord avec les mentors du projet, je vérifiais le chapitre du manuel dans le contrôle des sources, assemblais le rapport du projet et envoyais le projet comme terminé.