avgarcia/runcriticon / .claude/skills/architecture-diagramming
architecture-diagramming
VerifiedEstá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 secuencia o al actualizar archivos `docs/arquitectura/arquitectura.md`.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 1.8 KB |
| referencias/best-practices.md | markdown | 3.4 KB |
| referencias/c4-model.md | markdown | 1.2 KB |
| referencias/checklist.md | markdown | 710 B |
| referencias/diagramas.md | markdown | 1.6 KB |
| referencias/implementacion.md | markdown | 303 B |
referencias/best-practices.md
View on GitHub# Buenas Prácticas en Diagramación de Arquitectura
Síntesis de directrices de expertos de la industria (AWS, C4 Model, InfoQ, Mural).
## 1. Principios Fundamentales
### "Un Diagrama, Una Historia"
- **No intentes modelar todo el sistema en un único diagrama.** Conduce a resultados "feos" e ilegibles.
- **Usa Capas de Abstracción:** Sigue el modelo C4 (Context -> Container -> Component) para separar responsabilidades. Cada diagrama debe responder un conjunto específico de preguntas para una audiencia concreta.
### Diseño Centrado en la Audiencia
- **Conoce a tu observador:**
- _Ejecutivos/Producto_: Diagramas Context de alto nivel (límites del sistema, interacciones con usuarios).
- _Arquitectos/Líderes técnicos_: Diagramas de Container/Cloud Architecture (decisiones tecnológicas, protocolos).
- _Desarrolladores_: Diagramas de Component/ERD (estructura del código, esquema de base de datos).
- **Evita jerga:** Si debes usar siglas (p. ej., "RBAC", "OCR"), defínelas en una leyenda o nota.
## 2. Gobernanza Visual (La Regla "Sin Diagramas Feos")
### La Consistencia es Clave
- **Formas:** Usa la misma forma para el mismo concepto en todos los diagramas (p. ej., Cilindro = Base de Datos, Forma de persona = Usuario).
- **Colores:** Usa colores semánticamente, no decorativamente.
- _Ejemplo:_ Azul = Sistema Interno, Gris = Sistema Externo, Verde = Usuario.
- _Anti-patrón:_ Usar colores aleatorios solo para que "resalte".
- **Tamaño:** Mantén cajas relativamente uniformes a menos que el tamaño transmita significado (p. ej., anidamiento).
### La Leyenda es Obligatoria
- **Nunca asumas que el lector conoce tu notación.**
- **Todo diagrama debe tener una Leyenda** que defina:
- Formas de cajas (Container vs Sistema).
- Estilos de líneas (Sólido = Síncrono, Punteado = Asíncrono/Message Bus).
- Significado de flechas (Flujo de datos vs Dependencia).
- Significados de colores.
### Diseño y Flujo
- **Dirección:** Estandariza en **Left-to-Right (LR - De Izquierda a Derecha)** o **Top-Down (TD - De Arriba a Abajo)**.
- _LR_ suele ser mejor para flujos de datos y diagramas de infraestructura amplios.
- _TD_ es mejor para jerarquías y desgloses de componentes.
- **Espacio en blanco:** Deja espacio respirable. Los diagramas abarrotados implican falta de claridad en el diseño del sistema mismo.
## 3. Semántica y Notación
### Explicar Líneas y Flechas
- **Etiqueta cada arista.** Una flecha sin etiqueta es ambigua.
- **Sé específico:**
- _Malo:_ "Se comunica con"
- _Bueno:_ "HTTPS/JSON", "gRPC", "Pub/Sub"
- **Dirección:**
- _Dependencia:_ "A depende de B" (usualmente apunta a la dependencia).
- _Flujo de datos:_ "A envía datos a B" (apunta a B).
- _Aclara esto en la leyenda._
### Manejo de Metadatos
Todo diagrama (o el documento que lo contiene) debe indicar:
- **Alcance:** ¿Qué se muestra?
- **Estado:** ¿Borrador, Propuesto o Implementado?
- **Fecha/Versión:** ¿Cuándo fue esto preciso?
## 4. Anti-Patrones a Evitar
- **La "Caja Huérfana":** Todo nodo debe estar conectado a algo. Si está aislado, ¿por qué está ahí?
- **El Diagrama de "Todo":** Mezclar detalles de servidor físico (RAM/CPU) con flujos de usuario de alto nivel.
- **La "Sigla Misteriosa":** Usar "PIMS" o "DWH" sin definición.
- **Abstracción Inconsistente:** Mostrar una caja "Base de Datos" junto a una caja "Clase". Mantén niveles de abstracción consistentes.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 198k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |