BeanCRM Docs
BeanCRM Docs es la fuente versionada de documentacion interna del proyecto. Vive en el mismo repositorio que el codigo para que cada cambio funcional, tecnico o de proceso pueda revisarse junto con su implementacion.
Objetivos
Sección titulada «Objetivos»- Documentar features implementados en produccion y sus reglas vigentes.
- Documentar decisiones de arquitectura que explican como funciona el producto real.
- Registrar release notes y cambios relevantes para produccion.
- Definir como probar funcionalidades antes de moverlas a Done.
Regla de calidad
Sección titulada «Regla de calidad»Para features criticas, el build exitoso es necesario pero no suficiente. Una tarea debe incluir documentacion y pruebas proporcionales al riesgo cuando toca API, permisos, multi-tenant, datos clinicos, pagos, portal paciente, auditoria o experiencia de usuario critica.
Relacion con tareas
Sección titulada «Relacion con tareas»Cada tarea de desarrollo relevante debe indicar:
- Que documento se creo o actualizo.
- Que pruebas se agregaron o ejecutaron.
- Que riesgo queda si no se pudo cubrir algo.
- Que release note corresponde si cambia comportamiento visible o contrato tecnico.