reeduorg-docs/Guía-Para-Documentación.md

2.8 KiB

Guía Para La Documentación

Para facilitar la consistencia y control de autoría y versiones de toda la documentación por favor observar las siguientes convenciones:

  • No usar "espacios" en los nombres de los archivos, use en su lugar el guión (-) o subrayar (_).

  • Producir todos los documentos en formato de texto o texto enriquecido (.txt, .md, .rtf).

  • De requerir alguna aplicación especial para producir los documentos (por ejemplo si se requieren graficos, esquemas o presentaciones), utilice una aplicación de código abierto y produzca el documento en formato no-binario (.xml, .fodp, .fodt, .bpmn, .dmn, etc.).

Estructura de los archivos en el repositorio

Los archivos están organizados de la siguiente forma:

  1. Procesos y Funciones - Documentos de mapeo, diseño, mejoramiento y estandarizacón de procesos y especificaciones funcionales.

  2. Data y Sistemas - Documentos referentes al modelo de datos, arquitectura y desarrollo de sistemas de información.

  3. Gestión de Cambio y Comunicaciones - Documentos referentes al mapeo de stakeholders, desarrollo de mensajes, planeamiento y ejecución de las comunicaciones.

  4. Entrenamiento y Capacidades - Documentos de mapeo y manejo de competencias, desarrollo de materiales de entrenamiento, y desarrollo y ejecución de planes de entrenamiento.

  5. Preparación y Soporte Para la Implementación - Documentos relacionados a los planes, ejecución y soporte de las actividades de implementación de escenarios piloto y de producción específicos.

  6. Gerenciamiento de Proyectos - Documentos relacionados al planeamiento, ejecución, control y gobierno del proyecto.

Aplicaciones de código abierto recomendadas para la documentación

Propósito Aplicación Formato de salida
Documentos de texto o markdown MarkText, VS Code, Vim, Nano, Notepad, TextEdit, Pluma .txt, .md
Diagramas de flujo BPMN 2.0 bpmn.io .bpmn
Diagramas de decisión DMN 1.3 bpmn.io .dmn
Pizarras de trabajo colaborativo excalidraw.com .excalidraw
Presentaciones LibreOffice Impress .fodp
Hojas de cálculo LibreOffice Calc .fods
Texto enriquecido y de formato complejo LibreOffice Writer .fodt