## Directivas SIMCO v3.7.0 - Estandarizacion de Documentacion (7) - SIMCO-DOCUMENTACION-PROYECTO.md - SIMCO-NOMENCLATURA.md - SIMCO-ESTRUCTURA-DOCS.md - SIMCO-INVENTARIOS.md - SIMCO-TESTING.md - SIMCO-MIGRACIONES-BD.md - SIMCO-INTEGRACIONES-EXTERNAS.md ## Directivas SIMCO v3.8.0 - Mantenimiento de Documentacion (2) - SIMCO-MANTENIMIENTO-DOCUMENTACION.md - SIMCO-SINCRONIZACION-BD.md ## Templates (4) - TEMPLATE-INVENTARIO-PROYECTO.md - TEMPLATE-INTEGRACION-EXTERNA.md - TEMPLATE-MODULO-ESTANDAR.md - TEMPLATE-DEPRECACION.md ## Checklists (6) - CHECKLIST-DOCUMENTACION-PROYECTO.md - CHECKLIST-INVENTARIOS.md - CHECKLIST-NOMENCLATURA.md - CHECKLIST-MANTENIMIENTO-DOCS.md - CHECKLIST-SINCRONIZACION-BD.md - _MAP.md ## Perfil de Agente (1) - PERFIL-DOCUMENTATION-MAINTAINER.md ## Indices - INDICE-DIRECTIVAS-WORKSPACE.yml actualizado a v3.8.0 ## Submodulos actualizados (14) - gamilit, erp-core, michangarrito, template-saas - erp-suite, erp-construccion, erp-clinicas - erp-mecanicas-diesel, erp-retail, erp-vidrio-templado - trading-platform, betting-analytics - inmobiliaria-analytics, platform_marketing_content Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
4.7 KiB
4.7 KiB
TEMPLATE: Deprecación de Documento
Versión: 1.0.0 Alias: @TPL_DEPRECACION Referencia: SIMCO-MANTENIMIENTO-DOCUMENTACION.md Fecha: 2026-01-10
Instrucciones de Uso
- Copiar el bloque de deprecación al INICIO del documento obsoleto
- Completar todos los campos del bloque
- Actualizar el _MAP.md correspondiente con estado DEPRECATED
- Registrar en el changelog del proyecto
- Notificar a equipos afectados
Bloque de Deprecación
Agregar este bloque AL INICIO del documento, justo después del título:
---
## ⚠️ DOCUMENTO DEPRECADO
| Campo | Valor |
|-------|-------|
| **Estado** | DEPRECATED |
| **Fecha de deprecación** | {YYYY-MM-DD} |
| **Deprecado por** | {Motivo o referencia al cambio que lo hace obsoleto} |
| **Reemplazo** | [{Nombre del documento de reemplazo}]({ruta relativa}) |
| **Eliminar después de** | {YYYY-MM-DD} |
| **Responsable** | {Equipo o persona responsable de la eliminación} |
> **Nota:** Este documento será archivado/eliminado en la fecha indicada.
> Migrar cualquier referencia al documento de reemplazo.
---
Ejemplo Completo
Documento Original (antes)
# ET-API-AUTH-001: Especificación de Autenticación v1
## 1. Descripción
Sistema de autenticación basado en sesiones...
## 2. Endpoints
...
Documento Deprecado (después)
# ET-API-AUTH-001: Especificación de Autenticación v1
---
## ⚠️ DOCUMENTO DEPRECADO
| Campo | Valor |
|-------|-------|
| **Estado** | DEPRECATED |
| **Fecha de deprecación** | 2026-01-10 |
| **Deprecado por** | Migración a autenticación JWT (ver MCH-E05-auth) |
| **Reemplazo** | [ET-API-AUTH-002](./ET-API-AUTH-002.md) |
| **Eliminar después de** | 2026-02-10 |
| **Responsable** | backend-team |
> **Nota:** Este documento será archivado/eliminado en la fecha indicada.
> Migrar cualquier referencia al documento de reemplazo.
---
## 1. Descripción
Sistema de autenticación basado en sesiones...
## 2. Endpoints
...
Períodos de Gracia Recomendados
| Tipo de Documento | Período Mínimo | Acción Final |
|---|---|---|
| Especificaciones técnicas (ET-*) | 30 días | Eliminar |
| Requerimientos (RF-*) | 30 días | Eliminar |
| User Stories (US-*) | 30 días | Eliminar |
| Guías de usuario | 60 días | Eliminar |
| ADRs | 90 días | Archivar (nunca eliminar) |
| Históricos de proyecto | 90 días | Archivar |
| Documentación de API | 60 días | Eliminar |
Actualización de _MAP.md
Actualizar el _MAP.md del directorio con el estado:
| Archivo | Estado | Notas |
|---------|--------|-------|
| ET-API-AUTH-001.md | ~~DEPRECATED~~ | Reemplazado por ET-API-AUTH-002, eliminar 2026-02-10 |
| ET-API-AUTH-002.md | Activo | Versión actual |
Registro en Changelog
Agregar entrada en el changelog del proyecto:
## [2026-01-10] Deprecaciones
### Documentación
- **DEPRECATED:** `docs/02-especificaciones/ET-API-AUTH-001.md`
- Motivo: Migración a autenticación JWT
- Reemplazo: `ET-API-AUTH-002.md`
- Fecha de eliminación: 2026-02-10
Proceso de Archivado
Cuando el período de gracia termina:
Para documentos que se archivan (ADRs, históricos):
- Crear carpeta
99-archivo/si no existe - Mover documento a
99-archivo/ - Actualizar _MAP.md:
| Archivo | Estado | Notas | |---------|--------|-------| | 99-archivo/ET-API-AUTH-001.md | Archivado | Movido 2026-02-10 | - Registrar en changelog:
- **ARCHIVED:** `ET-API-AUTH-001.md` → `99-archivo/`
Para documentos que se eliminan:
- Verificar que no hay referencias activas al documento
- Eliminar el archivo
- Actualizar _MAP.md (remover entrada o marcar como eliminado)
- Registrar en changelog:
- **DELETED:** `ET-API-AUTH-001.md` - Período de gracia completado
Checklist de Deprecación
- [ ] Bloque de deprecación agregado al documento
- [ ] Fecha de deprecación correcta
- [ ] Documento de reemplazo indicado
- [ ] Fecha de eliminación establecida (mínimo según tipo)
- [ ] _MAP.md actualizado
- [ ] Changelog actualizado
- [ ] Equipos afectados notificados
- [ ] Referencias en otros documentos identificadas para migrar
Notas Importantes
- NUNCA eliminar sin deprecar primero - Siempre dar período de gracia
- NUNCA eliminar ADRs - Solo archivar, las decisiones son historia
- Verificar referencias - Antes de eliminar, buscar quién referencia el documento
- Notificar - Los equipos que usan el documento deben saber del cambio
- Documentar el reemplazo - Siempre indicar qué documento lo reemplaza
Referencia: @MANTENIMIENTO_DOCS