Sample of software project documentation.

Documentation.md

⚠️ Documentation Required ⚠️

[Rellena la siguiente plantilla]

Arquitectura del proyecto (front, back, infra)

Indicando quién es el responsable de cada área o proceso. (Recomiendo documentarlo como un diagrama de flujo o similar).

Aquí el tooling que utilizo para documentar Infra y procesos.

Decisiones tecnológicas

• Bibliotecas.
• Frameworks.
• Herramientas utilizadas.

Desarrollo Back y Front

• Módulos:
  • Módulos principales.
  • Módulos de negocio.
  • Módulos de soporte.
  • Módulos opcionales.
• Funciones.
• Interfaces.
• REST's API's.
• Pruebas unitarias.

Instrucciones para replicar el proyecto

• Comandos para levantar o correr el proyecto.
• Variables de entorno necesarias para establecer una configuración inicial o similar.

Configuración del proyecto

• Accesos y credenciales a herramientas, VPN, etc.
• Datos de ambientes del cliente (ej: servidores, plataformas, IPs, etc).
• Material de seguimiento y seguridad (tracking IDs scripts para Google Analytics, Hotjar, reCAPTCHA, etc).
• Documentación visual de componentes (frontend) o tests de integraciones (backend).

Detalle de las carpetas del proyecto

• Nombre de la carpeta.
• Función de la carpeta.
  • Archivos y descripción.
  • Extensiones admisibles de archivos.
  • Restricciones.
  • Consideraciones específicas.

Instrucciones para cambios que se pueden ejecutar

• Principales cambios.
• Instrucciones.
• Diagramas de funcionamiento.
• Consideraciones.
• Riesgos.
• Preguntas frecuentes a problemas comunes.