glossary

$npx mdskill add 686f6c61/alfred-dev/glossary

Define project terms to eliminate team communication ambiguity.

  • Prevents bugs caused by inconsistent terminology usage.
  • Scans code and documentation for ambiguous concepts.
  • Generates structured markdown tables with clear definitions.
  • Stores entries in a centralized docs/glossary.md file.

SKILL.md

.github/skills/glossaryView on GitHub ↗
---
name: glossary
description: "Crear y mantener un glosario de términos del proyecto para evitar ambigüedades. Activar ante: glosario, definir terminos, vocabulario del proyecto, que significa"
---

# Corpus lingüístico / Glosario del proyecto

## Resumen

Este skill crea y mantiene un glosario de términos del proyecto: un documento de referencia donde cada concepto tiene una definición única, consensuada y sin ambigüedades. El objetivo es que todo el equipo hable el mismo idioma: cuando alguien dice "usuario", todos entienden lo mismo.

Las malas interpretaciones entre miembros del equipo son una de las fuentes más frecuentes de bugs y retrabajos. Un glosario bien mantenido previene estos problemas de raíz.

## Proceso

### Paso 1: identificar términos clave

- Revisar el código fuente: nombres de entidades, modelos, servicios, tipos.
- Revisar la documentación existente: README, PRDs, historias de usuario.
- Identificar términos que se usan de forma inconsistente o ambigua.
- Preguntar al usuario si hay términos que generen confusión en el equipo.

### Paso 2: crear el fichero de glosario

Crear `docs/glossary.md` con la siguiente estructura:

```markdown
# Glosario del proyecto

| Término | Definición | Contexto | No confundir con |
|---------|-----------|----------|------------------|
| Usuario | Persona registrada con cuenta activa | Backend, API | Visitante (no registrado) |
| Sesión | Período de actividad autenticada | Auth | Conexión (socket) |
```

Cada entrada incluye:
- **Término**: la palabra o expresión exacta.
- **Definición**: qué significa en el contexto de este proyecto. Una frase, precisa.
- **Contexto**: dónde se usa (módulo, capa, dominio).
- **No confundir con**: términos similares que significan otra cosa.

### Paso 3: vincular con el código

- Verificar que los nombres en el código (variables, clases, funciones) son coherentes con el glosario.
- Si hay inconsistencias, proponer renombramientos o documentar la discrepancia.

### Paso 4: mantener actualizado

- Cada vez que se introduce un concepto nuevo en el proyecto, añadirlo al glosario.
- Si un término cambia de significado, actualizar la definición y notificar al equipo.

## Qué NO hacer

- No incluir términos genéricos de programación (API, endpoint, función). Solo términos específicos del dominio del proyecto.
- No escribir definiciones largas. Una frase por término, dos como máximo.
- No crear el glosario y olvidarlo. Un glosario desactualizado es peor que no tener ninguno.

More from 686f6c61/alfred-dev

SkillDescription
acceptance-criteriaGenerar criterios de aceptación en formato Given/When/Then. Activar cuando el usuario quiera definir criterios de aceptacion, usar formato Given When Then, escribir en Gherkin, saber como determinar que algo esta terminado o establecer una definicion de hecho.
architecture-docsUsar para documentar la arquitectura del sistema. Activar ante: documentar arquitectura, diagrama del sistema, como funciona el proyecto, vision general tecnica
bundle-sizeAnalizar y reducir el tamaño de bundles frontend. Activar cuando el bundle sea grande, se quiera reducir tamaño, aplicar tree shaking, configurar lazy loading, usar webpack analyzer o analizar el peso de la aplicacion.
choose-stackUsar para evaluar y elegir tecnologías con matriz de decisión ponderada. Activar cuando el usuario quiera elegir tecnología, comparar frameworks, decidir entre alternativas técnicas, construir una matriz de decisión, evaluar stack, seleccionar base de datos, elegir lenguaje o comparar herramientas.
ci-cd-pipelineConfigurar pipeline CI/CD adaptado al proyecto. Activar cuando el usuario quiera configurar CI, crear GitHub Actions, configurar GitLab CI, montar un pipeline de despliegue, automatizar tests o implementar integracion continua.
code-review-responseUsar al recibir feedback de code review para responder técnicamente. Activar cuando el usuario quiera responder a comentarios de PR, gestionar feedback de code review, resolver comentarios de un revisor, o cuando el revisor pide cambios en el código.
compliance-checkUsar para verificar cumplimiento RGPD, NIS2 y CRA. También: verificar RGPD, cumplimiento normativo, NIS2, CRA, Cyber Resilience Act, protección de datos, regulación europea.
copy-reviewRevisar textos publicos: claridad, tono, ortografia y CTAs. Activar ante: revisar textos, mejorar copy, tono de comunicacion, textos de la web, landing page copy
dependency-strategyEstrategia integral de gestion de dependencias: inventario, evaluacion de riesgo, politica de actualizaciones y documentacion. Usar para auditar el estado global de las dependencias del proyecto.
dependency-updateRevisar dependencias desactualizadas, con CVEs o end-of-life, y proponer actualizaciones seguras. También: actualizar paquetes, actualizar dependencias, Dependabot, Renovate, versión desactualizada, breaking changes.