Este documento establece los lineamientos para estructurar, redactar, almacenar y mantener la documentación interna de todos los proyectos desarrollados dentro de la fábrica de software. Su propósito es garantizar trazabilidad, comprensión y reutilización del conocimiento generado.
📁 Estructura Base por Proyecto en Notion
Cada proyecto activo debe contener los siguientes apartados documentados:
- Resumen Ejecutivo del Proyecto
- Objetivo
- Público objetivo
- Solución propuesta
- Requerimientos Funcionales y Técnicos
- Entradas esperadas
- Resultados esperados
- Reglas de negocio
- Diseño UI/UX (Borradores o imágenes)
- Prototipos (opcionalmente en Canva o Figma)
- Guías de colores, fuentes y espaciado
- Planificación del Desarrollo
- Fases del proyecto
- Entregables por fase
- Responsable (agente o humano)
- Código Fuente y Estructura de Carpetas
- Enlace a repositorio GitHub (rama por fase o versión)
- Descripción de carpetas y archivos
- Ejecución de Pruebas QA
- Casos de prueba ejecutados
- Errores detectados y corregidos
- Validación UAT final
- Versiones Publicadas y Cambios
- Registro de cada versión con fecha
- Funcionalidades agregadas o modificadas
- Notas Técnicas o de Soporte
- Dependencias, librerías usadas
- Errores recurrentes y soluciones aplicadas
- Consideraciones de compatibilidad
✍️ Estilo de Redacción
- Lenguaje técnico, claro y directo.
- Sin adornos comerciales ni palabras vacías.
- Uso de viñetas o listas para mejorar la legibilidad.
- Fechas claramente indicadas.
- Cada entrada debe tener responsable, fecha y estado (borrador / validado).