Skip to content

Estructura documental

La documentacion esta separada del frontend Angular para evitar acoplarla al ciclo de despliegue de la aplicacion principal.

txt
AgendaIntegralDocs/
  package.json
  docs/
    .vitepress/
      config.mts
      theme/
        custom.css
    modulos/
      agenda/
      pacientes/
      caja/
    plantillas/
      procedimiento.md
    public/
      assets/

Buenas practicas

  • Un archivo por accion de usuario.
  • Titulos en infinitivo: Crear cita, Reagendar cita, Cancelar cita.
  • Evitar mezclar reglas internas con instrucciones de usuario.
  • Usar tablas solo para errores, permisos o campos.
  • Mantener capturas por modulo.
  • Mantener el campo Estado de la plantilla en Validado para indicar que el procedimiento forma parte del manual oficial.

Como agregar un procedimiento

  1. Copiar docs/plantillas/procedimiento.md.
  2. Guardarlo en docs/modulos/<modulo>/<accion>.md.
  3. Agregarlo al sidebar en docs/.vitepress/config.mts.
  4. Ejecutar npm run build para validar enlaces y sintaxis.