Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- El proyecto FreeBSD
- Escritor técnico:
- cuaffeína
- Nombre del proyecto:
- Crear 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 de una guía del Manual de FreeBSD relacionado con la instalación, el uso y la solución de problemas de WINE (www.winehq.org) en FreeBSD. Mi objetivo es dedicar entre 4 y 8 horas por semana trabajando en los siguientes elementos, a menos que se indique lo contrario.
*** Vinculación comunitaria
Si me seleccionaban, dedicaría el período de vinculación comunitaria a que me familiaricé con la infraestructura y los procesos de documentación del proyecto FreeBSD. Siempre me ha impresionado la documentación cohesiva que ha publicado el proyecto, por lo que me pude comunicar con los miembros del equipo respecto a su flujo de trabajo. También me unía y exploraba 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 ayudar a trabajar con WINE en FreeBSD en particular.
Durante este período, dedicaría algo de tiempo a aprender la cadena de herramientas de la documentación del proyecto. Esto me permitirá ponerse en marcha durante las primeras semanas del proyecto si me seleccionan.
*** Semana 1 (14/9-2019): Instalaciones de prueba 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 que van desde utilidades simples hasta aplicaciones más complejas. Este es un enfoque que apliqué en un artículo similar que hice en ReactOS para MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), solo que usaría el tiempo de la primera semana para examinar una selección más amplia de programas.
Según mi experiencia, dedicar este tipo de tiempo al principio es útil para identificar (y solucionar) problemas generales de tipo "gotcha". De esta forma, podré tener las soluciones a mano cuando llegue el momento de escribir secciones relevantes o, al menos, solicitar asistencia a los canales adecuados.
Objetivo de la semana: obtener un resumen de los capítulos de instalación y los detalles necesarios para solucionar problemas de instalación habituales.
*** Semana 2 (21/9-25): documentación de la instalación de WINE
Durante la semana 2, redacté un borrador de las secciones para ilustrar la instalación de WINE a través de métodos populares, como los siguientes:
- Desde la fuente con el sistema de puertos;
- Mediante paquetes binarios con repositorios principales
- Usar administradores de paquetes de GUI disponibles (si están disponibles)
- De repositorios alternativos, como FreshPorts (y por qué un usuario querría hacerlo).
Para esta sección, es importante analizar las instalaciones simultáneas y de 32 bits frente a las de 64 bits a fin de destacar los pasos adicionales que requiere la ejecución de programas de diferentes arquitecturas.
Objetivo de la semana: un borrador pulido de las secciones que describen la instalación de WINE en FreeBSD. Este "borrador pulido" debe incluir casi el texto final (Revisión de texto pendiente y comentarios de revisión) y marcadores de posición para las capturas de pantalla, si no las capturas en sí.
*** Semana 3 (28/9 al 2/10): Dirigir tu primer programa WINE en FreeBSD
Una vez instalado el subsistema WINE, la siguiente sección detalla la instalación y ejecución de algunos programas iniciales. Es muy probable que estos se centren en utilidades independientes y simples, como el Notepad++ de código abierto. El objetivo es permitir a los usuarios descargar rápidamente una aplicación, instalarla y hacer que funcione con un mínimo de complicaciones.
Esta sección es importante para demostrar a los usuarios que algunas o varias 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 limpia y (en gran medida) listos para usar, y un borrador perfeccionado de las secciones que ilustran su instalación.
*** Semana 4 (10/5-9): Descripción general y conceptos de WINE
Al final de la sección anterior, se aludiría a la necesidad de algunos ajustes y personalización para lograr que ciertas aplicaciones funcionen en WINE, momento en el cual una introducción al subsistema WINE es útil para proporcionar contexto. En estas secciones, se examinaría lo que incluye el sistema WINE, cómo interactúa con FreeBSD y dónde un usuario podría comenzar a intentar comprender mejor el sistema o solucionar problemas.
Es importante tener en cuenta que esta sección no tiene como objetivo duplicar recursos existentes, sino presentar una descripción general organizada que se vincule a otras fuentes (fácilmente de asimilar) para obtener más información.
Objetivo de la semana: Un borrador detallado de las secciones que presentan el subsistema WINE a los usuarios.
*** Semana 5 (12/10-16): Configuración de WINE en FreeBSD
Estas secciones profundizarán más en la configuración real de WINE, comenzando con las modificaciones y ajustes generales específicos de FreeBSD. También ilustrarían el uso de las carpetas $WINEPREFIX, que se pueden utilizar para personalizar el entorno WINE para una aplicación en particular. Como existen recursos existentes que explican este concepto en profundidad, esta sección solo proporcionará una introducción moderadamente detallada antes de vincularlos.
Objetivos de la semana: Un borrador detallado de las secciones que detallan dónde, cómo y en qué circunstancias se requiere la configuración detallada de WINE.
*** Semana 6 (19/10-23): WINE GUI en FreeBSD
En la medida en que configurar WINE para que ejecute un programa determinado pueda ser un ejercicio complejo y lento, existen herramientas auxiliares que facilitan este proceso. En esta sección, se proporciona una descripción general de la instalación y el uso de algunas de las opciones disponibles en FreeBSD, incluidas las siguientes:
- WINECFG
- copas de vino
- playonbsd
- otros como disponibles
Objetivo de la semana: brindar secciones preliminares pulidas con instrucciones para instalar y usar la mayor cantidad posible de aplicaciones auxiliares de GUI WINE más populares.
*** Semana 7 (26/10 al 30): Preguntas frecuentes de WINE/FreeBSD (investigación)
Parte de la información más valiosa relacionada 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 ofrecen respuestas. Les ahorrará mucho tiempo a los usuarios si recopilan en un solo lugar algunas de estas preguntas frecuentes, en particular aquellas que se sabe que afectan a los usuarios de FreeBSD.
El objetivo de estas secciones es hacer precisamente eso. Esta semana, me gustaría investigar los tipos de problemas comunes que suelen tener los usuarios de FreeBSD con WINE y también investigar y, en la medida de lo posible, probar las respuestas. Esto permitirá que los lectores del capítulo del manual tengan muchas más oportunidades de resolver rápidamente un problema en particular.
En estas secciones, también se incluirá una lista de recursos sobre dónde buscar respuestas que este no haya brindado.
Objetivo de la semana: Borradores de secciones detalladas que contengan los problemas de WINE más comunes, ya sean experimentados por los usuarios de FreeBSD o en general, y vínculos o notas sobre sus soluciones. Tenga en cuenta que, aunque el trabajo de esta semana no tiene un borrador de resultado, es probable que se requiera una mayor inversión de tiempo para encontrar y conciliar problemas comunes, además de buscar sus soluciones. Esperaría dedicar alrededor de 8 a 10 horas a esta investigación.
*** Semana 8 (11/2-6): Preguntas frecuentes sobre WINE/FreeBSD
Esta semana se dedicaría a resumir la investigación de la semana 7 para crear las secciones sobre preguntas frecuentes y problemas comunes de solución de problemas (vincular a las soluciones según corresponda).
Objetivo de la semana: Un borrador refinado de las secciones con las preguntas frecuentes y los problemas frecuentes, así como las instrucciones paso a paso para resolverlos.
*** Semana 9 (11/9-13): Administración de WINE multiusuario
Esta(s) sección(es) ofrecería orientación a los administradores que buscan implementar WINE en un escenario multiusuario. 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: Borradores de secciones pulidas que detallen orientación y prácticas recomendadas para que los administradores de FreeBSD implementen aplicaciones basadas en WINE y WINE para varios usuarios.
*** Semana 10 (16/11-2020): Apéndices, comentarios de revisión y administración
Si bien me esforzaría por implementar los comentarios de los mentores y otros revisores a lo largo del proceso de redacción, esta semana podría dedicar tiempo a una reorganización o reescritura más extensa si es necesario.
Además, escribiría cualquier administración necesaria para este capítulo del manual (tema del frente, índices, etc.) durante este tiempo, así como organizar lecturas adicionales relacionadas con WINE (por ejemplo, usar la versión de Linux de WINE a través de compatibilidad binaria, DOSBox para juegos y programas antiguos, etc.).
Objetivo de la semana: un borrador pulido de todo el capítulo del manual que incluya todas las demás secciones.
*** Semana 11 (23/11-27): Finalización del capítulo del manual
La semana pasada, me gustaría dedicar la segunda y última semana a revisar todo el texto, revisar las imágenes y probar los distintos resultados (HTML, PDF, etc.) según sea necesario. Esta semana también permitirá actualizaciones en caso de que alguno de los software mencionados (desde FreeBSD hasta WINE o sus ayudantes) se actualice en el tiempo transcurrido desde su redacción inicial.
Objetivo de la semana: Versión final del capítulo del manual que incluye todas las actualizaciones necesarias.
*** Semana 12 (30/11 al 5/11): Finalización del proyecto
De acuerdo con los mentores del proyecto, revisaría el capítulo del Manual en el control de origen, armaría el informe del proyecto y enviaría el proyecto como completo.