architecture-diagramming

Estándares para crear diagramas de arquitectura C4 y UML claros y adecuados al público utilizando Mermaid. Usar al producir diagramas de contexto del sistema, vistas de contenedores, diagramas de secu

SKILL.md

GitHub

Estándar para Diagramas de Arquitectura

Directrices

  • Usar el modelo C4: Contexto -> Contenedor -> Componente -> Código.
  • Enfocado en el público: Ajusta el nivel de abstracción (Ejecutivos vs. Desarrolladores).
  • Seleccionar el tipo de diagrama: Secuencia (Protocolo), ERD (Datos), Estado (Ciclo de vida), Cloud (Infra). Ver Selección.
  • Etiquetas explícitas: Etiqueta todas las flechas (p. ej., "Utiliza", "HTTPS").
  • Notación consistente: Cilindros=BD, Rectángulos=Sistemas, Línea discontinua=Async.
  • Metadatos: Título, Fecha, Versión, Autor.
  • Leyenda obligatoria: Define todas las formas/colores/estilos.
  • Dirección: graph LR (flujo) o graph TD (jerarquía).
  • Despliegue: Mapea contenedores a infraestructura.
  • Gobernanza: CRÍTICO: Revisa best-practices.md antes de empezar.

Consulta implementation examples para un diagrama de contenedor C4 en Mermaid.

Anti-Patrones

  • Niveles mezclados: Columnas de BD en el Contexto del Sistema.
  • Flechas sin etiqueta: Relaciones ambiguas.
  • Formas misteriosas: No definidas en la leyenda.
  • Puntos muertos: Nodos sin conexión.
  • Exceso de elementos: >20 nodos/diagrama.
  • Acrónimos: Abreviaturas sin definir.

Referencias