# Documentación

## Documentación técnica

La documentación técnica será escrita en archivos con formato [Markdown](https://en.wikipedia.org/wiki/Markdown), la mayoría de los proyectos tendrá dos partes:
1. El README del repositorio, donde se encontrará una descripción breve del proyecto e instrucciones detalladas de instalación. La documentación deberá ser escrita en Inglés para los repositorios en GitHub.
1. Repositorio en el GitLab interno con instrucciones y consideraciones específicas de despliegue

## Diagramas

Para diagramas complejos o que requieren mucho formato, se recomienda utilizar [draw.io](https://www.drawio.com/). En este sitio puede cargar los archivos `.drawio.png` que se encuentran en repositorios como este para realizar las ediciones necesarias.

Para diagramas técnicos (por ejemplo, `diagramas de flujo` o `Entidad-Relación`), se deberá utilizar [MermaidJS](https://mermaid.js.org/intro/) en el repositorio correspondiente.

---
* volver al [inicio](/README.md)
* volver a las [normas de desarrollo](/docs/development-rules/README.md)
