Esta página contiene los detalles de un proyecto de redacción técnico aceptado para Google Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- moja global
- Redactor técnico:
- Antonio
- Nombre del proyecto:
- Documentación del código de la herramienta de informes
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Dada la oportunidad de documentar la Herramienta de informes para la organización Moja Global, propongo desarrollar 6 tipos de documentación que utilizarán distintos públicos para lograr distintos propósitos. Estos se resumen a continuación:
1) Guía de configuración del entorno
1.1) Ingenieros de sistemas del público objetivo
1.2) Objetivo: Ayudar a los ingenieros de sistemas a configurar un entorno de compilación y ejecución local para la herramienta de informes.
1.3) Formato de un artículo instructivo que prescribe el conjunto de pasos secuenciales que deben seguir los ingenieros de sistemas para configurar el entorno que será propicio para la compilación y ejecución de la herramienta de informes.
2) Guía de compilación
2.1) Ingenieros de sistemas del público objetivo
2.2) Objetivo: Ayudar a los ingenieros de sistemas a crear los componentes de la herramienta de informes a partir del código fuente
2.3) Formato de un artículo instructivo que indique el conjunto de pasos secuenciales que los ingenieros de sistemas deben seguir para obtener y compilar el código fuente de la herramienta de informes.
3) Guía de instalación
3.1) Ingenieros de sistemas del público objetivo
3.2) Objetivo: Ayudar a los ingenieros de sistemas a instalar componentes de herramientas de informes recién compilados
3.3) Formato de un artículo instructivo que prescribe el conjunto de pasos secuenciales que los ingenieros de sistemas deben seguir para implementar la herramienta de informes en un entorno de configuración reciente.
4) Guía de operación
4.1) Integradores de sistema del público objetivo
4.2) Objetivo Ayudar a los ingenieros de sistemas a ejecutar una instancia de herramienta de informes recién instalada
4.3) Formato de un artículo instructivo que prescribe el conjunto de pasos secuenciales que los integradores de sistemas deben seguir para subir y procesar bases de datos de salida de flujo en una instancia de la Herramienta de informes en ejecución.
Guía operativa Integrar y procesar bases de datos de salida de flujo en la herramienta de informes
5) Guía del usuario
5.1) Público objetivo Usuarios finales
5.2) Objetivo Ayudar a los Usuarios finales a comprender las distintas funciones incorporadas en la herramienta de informes y cómo se deben usar
5.3) Formato de un artículo instructivo que indique el conjunto de pasos secuenciales que los Usuarios Finales deben seguir para utilizar adecuadamente las Funciones de la Herramienta de Informes.
6) Guía de desarrollo
6.1) Público objetivo programadores
6.2) Objetivo Ayudar a los Usuarios finales a comprender las distintas funciones incorporadas en la herramienta de informes y cómo se deben usar
6.3) Formato de los artículos de referencia que describan lo siguiente: a) los principales elementos de diseño que componen la herramienta b) la descomposición funcional de los elementos anteriores c) los elementos de ejecución de los elementos descompuestos funcionalmente d) el código fuente o la organización de las bibliotecas de la herramienta e) la visión y la dirección a largo plazo para la mejora continua f) las próximas áreas lógicas para la mejora
Un breve instructivo en el que se describe cómo se puede ajustar el código a circunstancias específicas del usuario