docs: añadir ADR, diario, CHANGELOG y comando /entrada_diario
Infraestructura de documentación operativa y de decisiones: - docs/adr/ — Architecture Decision Records. Incluye plantilla y ADR 0001 documentando el experimento y retirada de GitButler. - docs/diary/ — diario de avances con un archivo por día. Primera entrada 2026-04-24.md retrocubriendo esta sesión (conectar aurgi-pc, dashboard fn_monitoring, funciones systemd locales, ADR GitButler, regla KISS). - CHANGELOG.md — formato Keep a Changelog para cambios cara a usuario/agentes. Sección 2026-04-24 con Added/Changed/Fixed/Removed. - .claude/commands/entrada_diario.md — slash command para añadir entradas al diario con formato consistente. Separación: diary = contexto operativo diario CHANGELOG = qué cambió en el código ADR = por qué se decidió algo rules = reglas operativas del agente Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,69 @@
|
||||
# /entrada_diario — Añadir entrada al diario del día
|
||||
|
||||
Añade una entrada nueva a `docs/diary/YYYY-MM-DD.md` con la fecha y hora actuales. Si el archivo del día no existe, lo crea con el encabezado del día. Si existe, **añade** una sección nueva al final (nunca sobrescribe ni reescribe entradas previas).
|
||||
|
||||
## Uso
|
||||
|
||||
```
|
||||
/entrada_diario <descripción o resumen del bloque de trabajo>
|
||||
```
|
||||
|
||||
Si no se pasa argumento, resume la sesión actual de forma concisa (qué hicimos, qué completamos, qué queda pendiente).
|
||||
|
||||
## Pasos que debe seguir el asistente
|
||||
|
||||
1. **Fecha y hora**:
|
||||
```bash
|
||||
DATE=$(date +%Y-%m-%d)
|
||||
TIME=$(date +%H:%M)
|
||||
```
|
||||
|
||||
2. **Ruta del archivo del día**: `docs/diary/${DATE}.md`
|
||||
|
||||
3. **Si el archivo NO existe**, crearlo con:
|
||||
```markdown
|
||||
# ${DATE}
|
||||
```
|
||||
|
||||
4. **Componer la entrada** en este formato exacto:
|
||||
```markdown
|
||||
|
||||
## ${TIME} — <título corto derivado del argumento>
|
||||
|
||||
<1-3 líneas de contexto breve si aplica>
|
||||
|
||||
- Hecho: <viñeta concreta>
|
||||
- Hecho: <viñeta concreta>
|
||||
- Pendiente: <viñeta si procede>
|
||||
|
||||
<Referencias opcionales: commit SHAs cortos, ADR #NNNN, issue #N, rutas a funciones del registry>
|
||||
```
|
||||
|
||||
5. **Añadir al final del archivo** (nunca editar secciones anteriores). Usar `Write` con el contenido completo si es el primer uso del día, `Edit` para append en días ya empezados.
|
||||
|
||||
## Reglas de estilo
|
||||
|
||||
- **Viñetas breves**, no párrafos. Si un punto necesita explicación larga, probablemente es un ADR en lugar de un diario.
|
||||
- **Verbos en pasado para lo hecho**, infinitivo para lo pendiente.
|
||||
- **Enlaces a artefactos**: commits (`SHA` corto de 7-8 chars), ADRs (`[0001](../adr/0001-...)`), funciones del registry por ID.
|
||||
- **No duplicar con CHANGELOG**: el diario es contexto operativo ("qué hice hoy"), el CHANGELOG es "qué cambió cara al usuario".
|
||||
- Si el argumento es vacío, revisar TaskList + cambios en git (`git log --since=today`, `git status`) y resumir en 3-5 viñetas.
|
||||
|
||||
## Ejemplos
|
||||
|
||||
```
|
||||
/entrada_diario cerrado issue #23 del dashboard, fix en http_client.cpp
|
||||
```
|
||||
|
||||
```
|
||||
/entrada_diario # sin args → resume sesión
|
||||
```
|
||||
|
||||
## Relación con otras formas de registro
|
||||
|
||||
| Si quieres documentar... | Usa |
|
||||
|--------------------------|-----|
|
||||
| Qué trabajé hoy | `/entrada_diario` → `docs/diary/` |
|
||||
| Qué cambió en el código (cara usuario/agentes) | Editar `CHANGELOG.md` directamente |
|
||||
| Por qué tomamos una decisión arquitectural | Nuevo ADR en `docs/adr/NNNN-*.md` |
|
||||
| Una regla operativa nueva del registry | Nuevo archivo en `.claude/rules/` + entrada en INDEX.md |
|
||||
Reference in New Issue
Block a user