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
- Escritor técnico:
- Krezhairo
- Nombre del proyecto:
- Referencia y guía del usuario de las funciones de Calc
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
SOLICITUD DE PROYECTO
Puedo dedicar fácilmente entre 30 y 35 horas a la semana durante la fase de redacción técnica y entre 10 y 12 horas en la fase previa a la redacción para aprender cualquier complemento de la habilidad necesaria para el proyecto. Me gustaría informarte que, actualmente, vivo en mi universidad(en mi país de origen), donde tengo acceso a Internet rápido y a cualquier recurso adicional necesario para el proyecto. Seguiré trabajando desde mi universidad durante toda la duración del proyecto, ya que, debido a la situación del COVID-19, no creo que mi universidad comience pronto. Y, aunque lo hiciera, estaría en mi último año, en el que solo debo asistir a clases de 5 a 6 horas a la semana, por lo que no afectaría al proyecto de ninguna manera.
INTRODUCCIÓN
LibreOffice Calc tiene una lista extensa (más de 500) de funciones en muchas categorías para las que la documentación es bastante superficial (pero precisa) en la Ayuda. El asistente de función integrado de Calc también proporciona al usuario información resumida sobre el propósito y los parámetros de cada función. Se creó una estructura en la wiki de The Document Foundation para capturar información de referencia más detallada sobre las funciones de Calc.
OBJETIVO
Para completar la estructura de la wiki escribiendo contenido más detallado para cada una de las funciones de Calc, fue útil marcar el cumplimiento del estándar de ODFF, incluidas ilustraciones y diagramas, y proporcionar uno o dos ejemplos para indicar casos extremos y excepciones, y proporcionar archivos de muestra.
PLAN DE TRABAJO DEL PROYECTO
Analicé en detalle la idea principal del proyecto y, en esencia, estamos tratando de documentar el funcionamiento de cada función en el asistente de funciones junto con ejemplos suficientes para cada una que cubra todos los aspectos de las funciones y tratar de hacer que la documentación sea lo más intuitiva posible para que un usuario nuevo pueda buscar y, en cuestión de segundos, comprender cómo usarla.
Consideraría dividir estas funciones por categorías:
• Database: This section deals with functions used with data organized as one row of data for one record.
• Date & Time: These spreadsheet functions are used for inserting and editing dates and times.
• Financial: This category contains the mathematical finance functions of LibreOffice Calc.
• Information: This category contains Information functions.
• Logical: This category contains Logical functions.
• Mathematical: This category contains the Mathematical functions for Calc.
• Array: This category contains the array functions.
• Statistical: This category contains Statistics functions.
• Spreadsheet: This section contains descriptions of the Spreadsheet functions together with an example.
• Text: This section contains descriptions of the Text functions.
• Add-in: The following describes and lists some of the available add-in functions.
Cada una tiene entre 20 y 50 funciones, y algunas categorías tienen más. La mayoría incluye una descripción superficial con sintaxis y un ejemplo.
Me gustaría agregar contenido más detallado para cada una de las funciones de Calc, marcar el cumplimiento del estándar ODFF, incluir ilustraciones y diagramas cuando sea útil, dar uno o dos ejemplos para indicar casos extremos y excepciones en forma de observaciones, y proporcionar archivos de muestra. También agrega una sección importante cuando sea útil. Consideraré abordar estas funciones en formato categórico, es decir, elegir una y trabajar verticalmente y, luego, pasar a otra categoría durante el período de redacción técnica. Además, consideraría acostumbrarme al entorno laboral durante el período de conexión con la comunidad para facilitar las cosas durante la fase de escritura. 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. En cuanto a la planificación, al principio, abordaría el proyecto analizando estas 11 categorías en las que trabajar. Por supuesto, algunas necesitarán más asistencia y, por lo tanto, más tiempo que otras, pero estos aspectos se pueden abordar mientras se trabaja. Dado que ya existe documentación y estoy escribiendo sobre ella, consideraré la revisión después de que se complete la tarea de cada semana, ya que no es bueno dejarla para la última semana.
Por lo tanto, a continuación hay un cronograma aproximado para organizar el proyecto dentro de los límites de tiempo.
- Semana 1:(14 de septiembre) • Base de datos
- Semana 2:(21 de septiembre) • Fecha y hora
- Semana 3:(28 de septiembre) • Financiero
- Semana 4:(5 de octubre) • Información
- Semana 5:(12 de oct.) • Lógica
- Semana 6:(19 de oct.) • Matemática
- Semana 7:(26 de octubre) • Array
- Semana 8:(2 de noviembre) • Estadística
- Semana 9:(9 de noviembre) • Hoja de cálculo
- Semana 10:(16 de noviembre) • Texto
- Semana 11:(23 de noviembre) • Complemento
- Semana 12:(del 30 de noviembre al 5 de diciembre)(final)
Documentar el trabajo realizado y la experiencia adquirida en este proyecto, y trabajar en aspectos menores, incluida la revisión o edición de la 2ª pasada si es necesario para preparar la documentación para su envío.