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:
- LibreOffice
- Redactor técnico:
- cuaffeína
- Nombre del proyecto:
- Guía en línea de LibreOffice: Es una guía similar a las que se usan para otras aplicaciones de LO que incluye no solo el uso, sino también la instalación y la administración.
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Si me eligen, planeo dedicar de ocho a diez horas por semana a escribir contenido nuevo y a modificar y reutilizar el contenido existente de la guía para crear la Guía de LibreOffice Online (LOOL). Con el ritmo al que escribo normalmente y dedicando entre ocho y diez horas por semana, espero producir una guía de aproximadamente 200 páginas o más.
He estado usando estas aplicaciones desde que reemplazaron a StarOffice y tengo las habilidades para usar las funciones avanzadas de las versiones de escritorio, como las siguientes:
- Estilos en todas las aplicaciones
- Documentos principales, referencias cruzadas, figuras y conceptos de autoedición en Writer
- Gráficos, gráficos y herramientas de análisis de datos en Calc
- Funciones de presentación interactivas, como transiciones y animaciones en Impress
Usé estas versiones para computadoras de escritorio en gran medida, tanto en el trabajo como en mi tiempo libre.
Con esta guía, me enfocaría en el usuario con conocimientos técnicos medios, ya que es probable que sean las personas que tienen la habilidad, la paciencia y, lo más importante, el interés en poner en funcionamiento algo como LOOL. En términos de referencia, debería tener contenido instructivo sencillo (por ejemplo, cómo poner en negrita una selección de texto), pero hay que suponer algunos conceptos técnicos (es decir, un servidor web es responsable de entregar la aplicación a un navegador).
Desde el punto de vista de la planificación, desde el principio abordaría el proyecto siguiendo el cronograma que se detalla a continuación. Nota: El orden en el que escribiré los capítulos no implica necesariamente su ubicación en la Guía final.
Semana 1: Comienza a explorar las instrucciones de instalación, prueba varios métodos de instalación y explora la aplicación
El objetivo de esta semana será realizar una instalación de LOOL que funcione correctamente. En mi experiencia, descubrir todos los pequeños momentos de "¡ajá!" de la documentación de este tipo de aplicaciones requiere una inversión de tiempo. Esta semana, intentaré resolverlos hasta el punto en que pueda instalar la aplicación fácilmente con cualquier método disponible sin que estos obstáculos me detengan.
Semana 2: Realiza instalaciones de referencia y documenta los métodos de instalación
Esta semana, te dedicarás a elaborar una lista aproximada de instrucciones de instalación (no en formato escrito completo, sino más bien ""por números"") y algunas notas que se incluirán en capítulos posteriores.
Semana 3: Escribe los capítulos del prefacio: prólogo, introducción, acerca de esta guía, etcétera.
El objetivo de esta semana será tener uno o más capítulos completos y pulidos que contengan toda la información relevante que necesita un lector antes de realizar la instalación.
Semana 4: Escribir los capítulos de instalación, parte 1
El objetivo de esta semana es completar y pulir las instrucciones de instalación de algunos de los métodos disponibles, en el formato de capítulo estándar de la Guía de LibreOffice, pero de una forma en la que se puedan reutilizar fácilmente, p.ej., para la wiki.
Semana 5: Escribe capítulos de instalación, parte 2
El objetivo de esta semana es completar y pulir las instrucciones de instalación para los métodos restantes, en el formato de capítulo estándar de la Guía de LibreOffice, pero de una forma en la que se puedan reutilizar fácilmente, p.ej., para la wiki.
Semana 6: Escribe el capítulo de configuración posterior a la instalación
El objetivo de esta semana es completar y pulir los capítulos sobre la configuración posterior a la instalación, como configurar las preferencias de la aplicación (p.ej., la zona horaria), configurar los usuarios y otras preparaciones que un administrador realizaría antes de poner el sistema en producción.
Semana 7: Escribe capítulos sobre navegación, interfaz y administración de archivos
El objetivo de esta semana serán capítulos completos y pulidos que, una vez leídos, harán que el lector se sienta familiar y se sienta cómodo trabajando en la IU.
Semana 8: Capítulos de Write Writer (procesamiento de texto)
Esta semana, deberías ver capítulos completos y pulidos que permitan a un usuario crear documentos con un diseño atractivo directamente en la app.
Semana 9: Escribe capítulos de Calc (hoja de cálculo)
El objetivo de esta semana es contar con capítulos completos y pulidos que permitan al usuario crear hojas de cálculo funcionales, incluida la selección de fórmulas y gráficos compatibles.
Semana 10: Escribe capítulos de presentación
El objetivo de esta semana será completar capítulos pulidos que permitan a un usuario crear una presentación interactiva con la capacidad de publicarla para el consumo sin conexión y para presentaciones en vivo.
Semana 11: Escribe capítulos de integración
El objetivo de la semana 11 es completar capítulos pulidos que le proporcionen al usuario una imagen completa de las opciones de integración disponibles. Es probable que la guía específica para integrar las apps sea en forma de vínculos a recursos relevantes, como páginas de wiki en Document Foundation o los proyectos integrados.
Semana 12: Ensamblar elementos diversos (apéndices, índices, tablas de figuras, etcétera) Revisión o corrección de 1ª pasada
Al final de esta semana, deberías tener una guía completa con contenido casi final y elementos intactos o en funcionamiento, como las referencias cruzadas.
Semana 13: Edición o revisión de segunda pasada, verificación de la composición tipográfica o el diseño, envío
Esta semana final, enviarás una guía completa y definitiva, editada en cuanto al contenido y la presentación.