Filosofía Docs-as-Code

Versión: 1.0
Estado: Borrador
Proyecto: Directorio de Clínicas Médicas

En este proyecto, la documentación se trata con el mismo rigor que el código fuente.

¿Por qué Docs-as-Code?

1. Versionamiento: Usamos Git para rastrear quién, cuándo y por qué se cambió una regla de negocio.
2. Revisión por Pares: Los cambios en la documentación .md se aprueban mediante Pull Requests.
3. Única Fuente de Verdad: No existen manuales en PDF o carpetas perdidas; todo lo que el equipo necesita saber está en este portal.

Herramientas del Ecosistema

• Docusaurus: Motor de generación de sitio estático.
• Markdown / MDX: Formato de escritura que permite incluir componentes de React (como el Embed de Miro).
• GitHub: Repositorio central de la documentación.
• Cursor/VS Code: Ambiente de desarrollo para la redacción y edición.

Reglas de Oro

• Si una funcionalidad cambia en el código, debe cambiar en el Markdown.
• Los diagramas lógicos se prefieren sobre las descripciones extensas.
• El Glosario debe consultarse antes de nombrar nuevas entidades en la base de datos.