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:
- LibreOffice
- Escritor técnico:
- Krezhairo
- Nombre del proyecto:
- Guía del usuario y referencia de las funciones de cálculo
- 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 escritura técnica y de 10 a 12 horas en la fase de preescritura para aprender cualquier otra habilidad necesaria para el proyecto. Te informo que, actualmente, vivo en una universidad(en mi país de origen), donde tengo acceso a Internet rápida y cualquier recurso complementario necesario para el proyecto. Continuaré desde la universidad durante todo el proyecto, ya que estamos en la situación del COVID-19. No veo que mi universidad comience pronto y, si lo hace, debería estar en mi último año de la semana en la que debería asistir a clases por solo 5 horas.
INTRODUCCIÓN
LibreOffice Calc tiene una lista extensa (más de 500) de funciones en muchas categorías para las cuales la documentación es bastante superficial (pero precisa) en Ayuda. El asistente de funciones 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 rellenar la estructura wiki escribiendo contenido más detallado para cada una de las funciones de Calc, marcar el cumplimiento del estándar ODFF, incluidas ilustraciones y diagramas, fue útil, dar uno o dos ejemplos para indicar casos límite y excepciones, y proporcionar archivos de muestra/ejemplo.
PLAN DE TRABAJO DEL PROYECTO
Estudié minuciosamente la idea central del proyecto y, en esencia, estamos tratando de documentar el funcionamiento de cada función en el asistente de funciones y con ejemplos suficientes para cada una que abarquen todos los aspectos de las funciones e intentar hacer que la documentación sea lo más intuitiva posible para que un usuario nuevo pueda buscar y en cuestión de segundos entender 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 pocas categorías tienen más. La mayoría de ellas 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, incluyendo ilustraciones y diagramas cuando sea útil, dar uno o dos ejemplos para indicar casos límite y excepciones en forma de observaciones y proporcionar archivos de muestra/ejemplo. También puedes agregar una sección importante cuando sea útil. Analizaré estas funciones en formato categórico, es decir, tomaré una, trabajaré verticalmente y, luego, pasaré a otra categoría durante el período de escritura técnica. Además, consideraría acostumbrarme al entorno de trabajo durante el período de vinculación con la comunidad para facilitar las cosas durante la fase de escritura. Según mi experiencia, descubrir todos los tantos pequeños momentos 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 utilizando estas 11 categorías para trabajar. Por supuesto, algunos necesitarán más asistencia y, por lo tanto, necesitarán más tiempo que otros, pero estos aspectos pueden abordarse mientras se trabaja. Como ya hay cierta documentación y estoy escribiendo sobre ella, voy a considerar la revisión después de que se haya realizado la tarea de cada semana, ya que no es bueno dejarla durante 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) • Finanzas
- Semana 4:(5 de oct) • Información
- Semana 5:(12 de oct) • Lógico
- Semana 6:(19 de oct) • Matemáticas
- Semana 7:(26 de oct) • Array
- Semana 8:(2 de nov) • Estadísticas
- Semana 9:(9 de nov) • Hoja de cálculo
- Semana 10 (16 de nov) • Texto
- Semana 11 (23 de nov) • Complemento
- Semana 12:(del 30 de nov al 5 de dic)(final)
Documentar el trabajo realizado y la experiencia adquirida en este proyecto, así como trabajar en tareas menores, incluyó la revisión o edición de la segunda prueba si es necesario a fin de que la documentación esté lista para el envío.