Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- El proyecto FreeBSD
- Escritor técnico:
- quaffeine
- Nombre del proyecto:
- Crea un capítulo del manual de Wine
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Como parte de esta iniciativa, produciría un capítulo detallado y de orientación del Manual de FreeBSD relacionado con la instalación, el uso y la solución de problemas de WINE (www.winehq.org) en FreeBSD. Te recomiendo que dediques entre 4 y 8 horas a la semana a trabajar en los siguientes aspectos, a menos que se indique lo contrario.
*** Vinculación con la comunidad
Si me eligen, pasaría el período de vinculación con la comunidad familiarizándome con los procesos de documentación y la infraestructura del proyecto FreeBSD. Siempre me ha impresionado la documentación coherente que publicó el proyecto y me comunicaría con los miembros del equipo del proyecto en relación con su flujo de trabajo. También me uniría a foros orientados a los usuarios para tener una idea de lo que ayudaría a los usuarios de FreeBSD con respecto a la documentación en general y a trabajar con WINE en FreeBSD en particular.
Durante este período, pasaría un tiempo aprendiendo la cadena de herramientas de la documentación del proyecto. Esto me permitirá comenzar a trabajar durante las primeras semanas del proyecto si me eligen.
*** Semana 1 (del 14 al 19 de septiembre): Prueba de instalaciones y solución de problemas
Pasaría la primera semana de la fase de desarrollo de documentos realizando una instalación de prueba de WINE en la versión estable actual de FreeBSD, además de instalar y ejecutar una variedad de aplicaciones de Windows, desde utilidades simples hasta aplicaciones más complejas. Este es un enfoque que apliqué en un artículo similar que realicé sobre ReactOS para MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/). Solo usaría el tiempo de la primera semana para examinar una selección más amplia de programas.
En mi experiencia, dedicar este tipo de tiempo al principio es útil para identificar (y solucionar) problemas generales de "captura". De esta forma, podré tener las soluciones a mano cuando llegue el momento de escribir secciones relevantes o, al menos, tener solicitudes de asistencia enviadas a los canales apropiados.
Objetivo de la semana: Tener un esquema de los capítulos de instalación y los detalles necesarios para solucionar problemas comunes de instalación.
*** Semana 2 (del 21 al 25 de septiembre): Documentación de la instalación de WINE
Durante la semana 2, redactaría las secciones que ilustran la instalación de WINE a través de métodos populares, incluidos los siguientes:
- Desde la fuente con el sistema de puertos
- A través de paquetes binarios con repositorios principales
- Usar los administradores de paquetes de la GUI disponibles, si están disponibles
- Desde repositorios alternativos, como FreshPorts (y por qué un usuario querría hacerlo).
En esta sección, es importante analizar las instalaciones simultáneas y de 32 y 64 bits para destacar los pasos adicionales que requieren la ejecución de programas de diferentes arquitecturas.
Objetivo de la semana: Una versión pulida del borrador de las secciones que describen la instalación de WINE en FreeBSD. Este "“borrador pulido”” debe incluir texto casi definitivo (revisión de texto pendiente y comentarios de revisión) y marcadores de posición para capturas de pantalla, si no son las capturas de pantalla en sí.
*** Semana 3 (del 28 de septiembre al 2 de octubre): Ejecuta tu primer programa de WINE en FreeBSD
Una vez que se instale el subsistema WINE, la siguiente sección detallará la instalación y ejecución de algunos programas iniciales. Es probable que se enfoquen en utilidades simples y autónomas, como Notepad++, de código abierto. El objetivo es permitir que los usuarios descarguen una aplicación rápidamente, la instalen y la vean funcionando con el mínimo esfuerzo.
Esta sección es importante para demostrar a los usuarios que algunas o muchas aplicaciones de Windows pueden ejecutarse en FreeBSD, lo que la convierte en una opción viable para el procesamiento diario.
Objetivo de la semana: Identificar una pequeña cantidad de programas que se instalen de forma correcta y funcionen (en gran medida) de inmediato, y una versión pulida del borrador de las secciones que ilustren su instalación.
*** Semana 4 (del 5 al 9 de octubre): Descripción general y conceptos de WINE
El final de la sección anterior aludía a la necesidad de realizar algunos ajustes y personalizaciones para que ciertas aplicaciones funcionen en WINE. En ese punto, es útil una introducción al subsistema WINE para proporcionar contexto. En estas secciones, se examina lo que incluye el sistema WINE, cómo interactúa con FreeBSD y dónde podría comenzar a buscar el usuario para comprender mejor el sistema o solucionar problemas.
Es importante tener en cuenta que el objetivo de esta sección no es duplicar los recursos existentes, sino presentar una descripción general organizada que incluya vínculos a otras fuentes (de fácil comprensión) para obtener más información.
Objetivo de la semana: Un borrador pulido de las secciones en las que se presenta el subsistema WINE a los usuarios.
*** Semana 5 (10/12-16): Configuración de WINE en FreeBSD
Estas secciones profundizan más en la configuración real de WINE, comenzando con modificaciones y ajustes generales específicos de FreeBSD. También ilustrarán el uso de las carpetas $WINEPREFIX, que se pueden usar para personalizar el entorno de WINE para una aplicación en particular. Como existen recursos que explican este concepto en profundidad, esta sección solo proporcionaría una introducción moderadamente detallada antes de vincularlos.
Objetivos de la semana: Es un borrador pulido de las secciones que detallan dónde, cómo y en qué circunstancias se requiere una configuración detallada de WINE.
*** Semana 6 (del 19 al 23 de octubre): GUI de WINE en FreeBSD
Dado que configurar WINE para ejecutar un programa determinado puede ser un ejercicio complejo y lento, existen herramientas de ayuda para facilitar este proceso. En estas secciones, se proporciona una descripción general de la instalación y el uso de algunas de las opciones que existen en FreeBSD, incluidas las siguientes:
- WINECfg
- winetricks
- playonbsd
- otros según estén disponibles
Objetivo de la semana: Proporcionar secciones de borrador pulidas con instrucciones para instalar y usar tantas de las aplicaciones de ayuda de WINE de GUI más populares como sea posible.
*** Semana 7 (26/10 al 30): Preguntas frecuentes de WINE y FreeBSD (investigación)
Parte de la información más valiosa en relación con aplicaciones técnicas complejas como WINE se puede encontrar en la interacción entre los usuarios que intentan resolver problemas particulares y los expertos que brindan respuestas. Les ahorrará mucho tiempo si se recopilan en un solo lugar algunas de estas preguntas frecuentes, en especial aquellas que se sabe que afectan a los usuarios de FreeBSD.
Estas secciones apuntan a hacer precisamente eso, y me gustaría dedicar esta semana solo a investigar los tipos de problemas que los usuarios de FreeBSD suelen tener con WINE, así como a buscar y (en la medida de lo posible) probar las respuestas. Esto les dará a los lectores de este capítulo del Manual una mejor oportunidad de resolver rápidamente un problema en particular.
En estas secciones, también se incluiría una lista de recursos para buscar respuestas que no se proporcionaron.
Objetivo de la semana: Sección de borradores pulidos que contengan los problemas más comunes de WINE, ya sea como los experimentan los usuarios de FreeBSD o en general, y vínculos o notas sobre sus soluciones. Ten en cuenta que, si bien el trabajo de esta semana no tiene un borrador como resultado, es probable que requiera una mayor inversión de tiempo para encontrar y conciliar los problemas comunes, así como para rastrear sus soluciones. Yo esperaría dedicar entre 8 y 10 horas a esta investigación.
*** Semana 8 (del 2 al 6 de noviembre): Preguntas frecuentes sobre WINE y FreeBSD
Esta semana, te dedicarás a sintetizar la investigación de la semana 7 para crear las secciones sobre preguntas frecuentes o problemas habituales de solución de problemas (con vínculos a las soluciones según corresponda).
Objetivo de la semana: Un borrador pulido de las secciones con las preguntas frecuentes y los problemas que se experimentan con frecuencia, así como instrucciones paso a paso para resolverlos.
*** Semana 9 (del 9 al 13 de noviembre): Administración multiusuario de WINE
Estas secciones ofrecerían orientación a los administradores que deseen implementar WINE en una situación de varios usuarios. Incluiría no solo las prácticas recomendadas para compartir el subsistema entre varios usuarios, sino también con respecto a las aplicaciones de Windows implementadas en WINE.
Objetivo de la semana: Unas secciones de borrador pulidas que detallen la orientación y las prácticas recomendadas para que los administradores de FreeBSD implementen WINE y aplicaciones basadas en WINE para varios usuarios.
*** Semana 10 (del 16 al 20 de noviembre): Apéndices, revisión de comentarios y administración
Si bien me esforzaría por implementar cualquier comentario que reciba de los mentores y otros revisores durante el proceso de redacción, esta semana me permitiría reorganizar o reescribir el texto de forma más extensa si fuera necesario.
Además, durante este tiempo, escribiría cualquier material administrativo necesario para este capítulo del manual (material preliminar, índices, etc.), así como reunir más lecturas relacionadas con WINE (p.ej., usar la versión de Linux de WINE a través de la compatibilidad binaria, DOSBox para juegos o programas antiguos, etc.).
Objetivo de la semana: Un borrador pulido de todo el capítulo del manual, incluidas todas las demás secciones.
*** Semana 11 (del 23 al 27 de noviembre): Finalización del capítulo del manual
Te recomiendo que dediques esta penúltima semana a revisar todo el texto, verificar las imágenes y probar los diversos resultados (HTML, PDF, etc.) según sea necesario. Esta semana también permitirá actualizaciones en caso de que alguno de los softwares anteriores (desde FreeBSD hasta WINE o sus ayudantes) se actualice desde su escritura inicial.
Objetivo de la semana: Versión final del capítulo del manual, incluidas todas las actualizaciones necesarias.
*** Semana 12 (del 30/11 al 5/12): Finalización del proyecto
Al acordar con los mentores del proyecto, consultaría el capítulo del manual en el control de la fuente, organizaría el informe del proyecto y enviaría el proyecto como completado.