En esta página, se incluyen 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:
- Anthony
- 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
Dado que tengo la oportunidad de documentar la herramienta de informes para la organización de Moja Global, propongo desarrollar 6 tipos de documentación que utilizarán diferentes públicos para lograr diferentes propósitos. Estos se resumen a continuación:
1) Guía de configuración del entorno
1.1) Público objetivo Ingenieros de sistemas
1.2) Objetivo Ayuda a los ingenieros de sistemas a configurar un entorno de compilación y ejecución local para la herramienta de informes.
1.3) Formato: 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 de público objetivo
2.2) Objetivo Ayuda a los ingenieros de sistemas a compilar los componentes de la herramienta de informes a partir del código fuente.
2.3) Formato: Artículo instructivo que prescribe el conjunto de pasos secuenciales que deben seguir los ingenieros de sistemas para obtener y compilar el código fuente de la herramienta de informes.
3) Guía de instalación
3.1) Ingenieros de sistemas de público objetivo
3.2) Objetivo: Ayudar a los ingenieros de sistemas a instalar componentes de la herramienta de informes recién compilados
3.3) Formato: Artículo instructivo que prescribe el conjunto de pasos secuenciales que deben seguir los ingenieros de sistemas para implementar la herramienta de informes en un entorno recién configurado.
4) Guía de operación
4.1) Integradores de sistemas para el público objetivo
4.2) Objetivo Ayudar a los ingenieros de sistemas a ejecutar una instancia de la herramienta de informes instalada recientemente
4.3) Formato Es un artículo instructivo que describe 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 operaciones: Cómo integrar y procesar bases de datos de salida de 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 diferentes funciones incorporadas en la herramienta de informes y cómo se deben usar.
5.3) Formato Un Artículo instructivo que indique el conjunto de pasos secuenciales que los Usuarios Finales deben seguir para usar adecuadamente las Funciones de la Herramienta de informes.
6) Guía de desarrollo
6.1) Programadores de público objetivo
6.2) Objetivo: Ayudar a los usuarios finales a comprender las diferentes funciones incorporadas en la herramienta de informes y cómo deben usarse.
6.3) Crear artículos de referencia que describan 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 próximas áreas lógicas de mejora.
Y un instructivo breve que describe cómo se puede ajustar el código a circunstancias específicas del usuario