# Joyanlabs Template Nestjs Dashboard Better Auth Documentation > Cuándo Usar Este Skill - Skill: `tomevault-io/joyanlabs-template-nestjs-dashboard-better-auth-documentatio` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/joyanlabs-template-nestjs-dashboard-better-auth-documentatio` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/joyanlabs-template-nestjs-dashboard-better-auth-documentatio/raw - Safety review: pending (external: skill-scanner FAIL, skillspector PASS) - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Docs & Writing - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/joyanlabs-template-nestjs-dashboard-better-auth-documentatio --- ## Cuándo Usar Este Skill Usar este skill cuando: - Se implementa una nueva funcionalidad que necesita documentación - Se crea un nuevo contexto o módulo - Se modifica la arquitectura del proyecto - Se detecta documentación desactualizada o inconsistente - Se necesita asociar un doc a un skill **NO usar cuando:** - Es una corrección menor de typo (editar directamente) - La funcionalidad es trivial o temporal - Ya existe documentación equivalente --- ## Principios de Documentación ### Jerarquía docs/ vs skills/ ``` docs/ # Para humanos (lectura continua, guías) ├── ARCHITECTURE.md # Visión general, punto de entrada ├── {feature}.md # Guías específicas de funcionalidades └── ... skills/ # Para IA (referencia rápida, patrones) ├── {skill}/ │ ├── SKILL.md # Patrones críticos, árboles de decisión │ └── references/ # Links a docs/ relacionados ``` ### Reglas de Oro | ✅ SÍ HACER | ❌ NO HACER | |-------------|-------------| | Crear un doc POR funcionalidad principal | Duplicar contenido entre docs | | Referenciar el skill relacionado | Crear doc sin skill asociado | | Usar plantilla estándar | Inconsistentes formatos de fecha | | Mantener docs < 15KB (dividir si es más grande) | Docs monolíticos gigantes | | Actualizar fecha en cada cambio | Docs obsoletos sin fecha actualizada | | Usar `YYYY-MM-DD` para fechas | Formatos variados de fechas | --- ## Estructura de Documentos ### Ubicación según el tipo ``` ¿Qué estás documentando? │ ├─ Arquitectura general del proyecto? │ └─ docs/ARCHITECTURE.md │ ├─ Funcionalidad específica de un contexto? │ └─ docs/{CONTEXT}_{FEATURE}.md │ Ej: docs/USER_AUTH.md, docs/PAYMENT_STRIPE.md │ ├─ Patrón reutilizable (aplica a varios contextos)? │ └─ docs/{PATTERN}.md │ Ej: docs/PORTS_ADAPTERS.md, docs/CQRS.md │ ├─ Guía de operaciones/DevOps? │ └─ docs/{TOPIC}.md │ Ej: docs/DOCKER_DEPLOYMENT.md, docs/SETUP.md │ └─ Integración con servicio externo? └─ docs/{SERVICE}.md Ej: docs/BETTER_AUTH.md, docs/INNGEST.md ``` ### Asociación con Skills TODO documento en docs/ DEBE estar asociado a al menos un skill: | Tipo de Doc | Skill Asociado | Ejemplo | |-------------|----------------|---------| | Arquitectura | `template-backend` o `nestjs` | ARCHITECTURE.md → template-backend | | Feature específica | Skill del contexto | USER_AUTH.md → better-auth | | Patrón reutilizable | Skill más cercano | PORTS_ADAPTERS.md → nestjs | | Operaciones/DevOps | `template-backend` | DOCKER_DEPLOYMENT.md → template-backend | | Servicio externo | Skill del servicio | BETTER_AUTH.md → better-auth | --- ## Plantilla Estándar Usar SIEMPRE esta plantilla para nuevos documentos: Ver [assets/doc-template.md](assets/doc-template.md) --- ## Decision Tree: ¿Necesitas un nuevo doc? ``` ¿Estás implementando algo nuevo? │ ├─ ¿Es un patrón/arquitectura que afecta múltiples contextos? │ ├─ SÍ: ¿Ya existe PORTS_ADAPTERS.md o similar? │ │ ├─ SÍ: Actualizar doc existente │ │ └─ NO: Crear docs/{PATRON}.md │ └─ NO: Continuar... │ ├─ ¿Es una integración con servicio externo? │ ├─ SÍ: ¿Existe docs/{SERVICIO}.md? │ │ ├─ SÍ: Actualizar doc existente │ │ └─ NO: Crear docs/{SERVICIO}.md │ └─ NO: Continuar... │ ├─ ¿Es funcionalidad específica de un contexto? │ ├─ SÍ: ¿Existe skill para este contexto? │ │ ├─ SÍ: Crear docs/{CONTEXT}_{FEATURE}.md │ │ └─ NO: Crear skill primero, luego doc │ └─ NO: Continuar... │ └─ ¿Es guía de operaciones/DevOps? └─ Crear docs/{TOPIC}.md (ej: DEPLOYMENT, SETUP) ``` --- ## Checklist de Calidad Antes de finalizar un documento, verificar: - [ ] Usa la plantilla estándar - [ ] Tiene skill asociado en sección "Recursos" - [ ] Skill relacionado tiene referencia en `references/docs.md` - [ ] Fecha actualizada con formato `YYYY-MM-DD` - [ ] No duplica contenido de otros docs (verificar con grep) - [ ] Tamaño < 15KB (si es más grande, considerar dividir) - [ ] Comandos de código funcionan (testeados) - [ ] Links a otros docs funcionan (no rotos) - [ ] Referencias a skills usan paths relativos correctos --- ## Actualizar Documentación Existente ### Flujo de actualización 1. **Identificar el doc**: `docs/{nombre}.md` 2. **Identificar skill asociado**: Ver sección "Recursos" del doc 3. **Actualizar contenido**: Mantener formato estándar 4. **Actualizar fecha**: Cambiar a fecha actual `YYYY-MM-DD` 5. **Verificar skills**: Asegurar que references/docs.md apunte a doc 6. **Ejecutar skill-sync**: `./skills/skill-sync/assets/sync.sh` ### Cambios menores vs Mayores | Tipo de Cambio | Acción | Actualizar Fecha | |----------------|--------|------------------| | Typos, formato | Commit directo | Opcional | | Nueva sección | Commit con descripción | SÍ | | Reestructuración | PR recomendado | SÍ | | Nuevo doc | PR requerido | SÍ (nueva) | --- ## Comandos Útiles ```bash # Verificar tamaño de docs ls -lh docs/*.md | awk '{print $5, $9}' # Buscar docs sin skill asociado ls docs/*.md 2>/dev/null # Buscar fechas inconsistentes grep -n "Última actualización" docs/*.md 2>/dev/null | grep -v "YYYY-MM-DD" # Buscar duplicaciones de contenido find docs/ -name "*.md" -exec grep -h "^## " {} \; 2>/dev/null | sort | uniq -d ``` --- ## Resources - **Plantilla**: Ver [assets/doc-template.md](assets/doc-template.md) - **Skill Creator**: [../../skill-creator/SKILL.md](../../skill-creator/SKILL.md) - Para crear skills asociados - **Skill Sync**: [../../skill-sync/SKILL.md](../../skill-sync/SKILL.md) - Para mantener AGENTS.md actualizado --- > Source: [JoyanLabs/template-nestjs-dashboard-better_auth](https://github.com/JoyanLabs/template-nestjs-dashboard-better_auth) — distributed by [TomeVault](https://tomevault.io).