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:
- moja global
- Escritor técnico:
- Antonio
- Nombre del proyecto:
- Documentación sobre el 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 distintos públicos utilizarán para lograr distintos propósitos. Estas se resumen a continuación:
1) Guía de configuración del entorno
1.1) Ingenieros de sistemas de 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) Dar formato a un artículo instructivo que prescribe el conjunto de pasos secuenciales que los ingenieros de sistemas deben seguir para configurar el entorno que será propicio para la creació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 compilar los componentes de la herramienta de informes a partir del código fuente
2.3) Dar formato a un artículo instructivo que prescribe 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 Herramienta de informes recién creados
3.3) Dar formato a 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 sistemas de público objetivo
4.2) Objetivo Ayudar a los ingenieros de sistemas a ejecutar una instancia de Herramienta de informes instalada de manera reciente
4.3) Formato de un artículo instructivo que indica 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 de operación Integra y procesa bases de datos de salida Flux 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 la manera en que se deben usar.
5.3) Dar formato a un artículo instructivo que indique el conjunto de pasos secuenciales que los Usuarios finales deben seguir para utilizar adecuadamente las Funcionalidades 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) Artículos de referencia de formato que describen lo siguiente: a) los principales elementos de diseño que conforman la herramienta b) la descomposición funcional de los elementos anteriores c) los elementos de ejecución de los elementos descompuestos funcionalmente d) la organización del código fuente o las bibliotecas de la herramienta e) la visión y la dirección a largo plazo para la mejora continua f) las siguientes áreas lógicas para la mejora
Y un instructivo breve en el que se describe cómo se puede ajustar el código a circunstancias específicas del usuario.