- HERENCIA-SIMCO.md actualizado con directivas v3.7 y v3.8 - Actualizaciones de configuracion Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
6.3 KiB
6.3 KiB
Guia de Mantenimiento de Estandares SIMCO v3.7
Proyecto: template-saas Version: 1.0.0 Fecha: 2026-01-10 Sistema: SIMCO v3.7
1. Proposito
Esta guia establece las pautas para mantener los estandares SIMCO v3.7 en la documentacion del proyecto template-saas. Asegura que todos los documentos nuevos y modificados cumplan con las directivas heredadas del workspace.
2. Directivas SIMCO Aplicables
El proyecto hereda las siguientes directivas:
| Directiva | Archivo | Alcance |
|---|---|---|
| @DOC_PROYECTO | SIMCO-DOCUMENTACION-PROYECTO.md | Estructura de carpetas |
| @NOMENCLATURA | SIMCO-NOMENCLATURA.md | Patrones de nombres |
| @ESTRUCTURA_DOCS | SIMCO-ESTRUCTURA-DOCS.md | Estructura interna |
| @INVENTARIOS | SIMCO-INVENTARIOS.md | Formato YAML |
| @INTEGRACIONES | SIMCO-INTEGRACIONES-EXTERNAS.md | Template integraciones |
Ver: HERENCIA-SIMCO.md para detalles completos.
3. Templates por Tipo de Documento
3.1 Nuevos Modulos SAAS (SAAS-NNN-nombre.md)
---
id: "SAAS-NNN"
title: "Titulo del Modulo"
type: "Module"
status: "Draft|InReview|Approved|Published|Deprecated"
priority: "P0|P1|P2|P3"
module: "nombre_modulo"
version: "1.0.0"
created_date: "YYYY-MM-DD"
updated_date: "YYYY-MM-DD"
---
# SAAS-NNN: Titulo del Modulo
## Metadata
| Campo | Valor |
|-------|-------|
| Codigo | SAAS-NNN |
| Modulo | Nombre |
| Prioridad | P0/P1/P2 |
| Estado | Completado/En Progreso |
| Fase | N - Descripcion |
---
## Descripcion
{Parrafo descriptivo del modulo}
## Objetivos
1. {Objetivo 1}
2. {Objetivo 2}
## Alcance
### Incluido
- {Feature 1}
- {Feature 2}
### Excluido
- {Feature excluida}
## {Contenido especifico del modulo}
...
## Referencias
- [Documento relacionado](./path/to/doc.md)
---
**Ultima actualizacion:** YYYY-MM-DD
**Version:** 1.0.0
**Autor:** {Nombre}
3.2 Nuevas Integraciones (INT-NNN-nombre.md)
# INT-NNN: Nombre Integracion
## Metadata
| Campo | Valor |
|-------|-------|
| Codigo | INT-NNN |
| Proveedor | {Nombre proveedor} |
| Tipo | {Pagos|Auth|Notificaciones|Storage|etc} |
| Estado | Implementado |
| Multi-tenant | Si |
| Fecha integracion | YYYY-MM-DD |
---
## Descripcion
{Parrafo descriptivo}
## Credenciales Requeridas
| Variable de Entorno | Descripcion | Obligatorio |
|---------------------|-------------|-------------|
| {PROVIDER}_API_KEY | API Key | SI |
## Endpoints/SDK Utilizados
| Operacion | Endpoint/Metodo | Descripcion |
|-----------|-----------------|-------------|
| {operacion} | {endpoint} | {descripcion} |
## Rate Limits
| Limite | Valor | Accion si excede |
|--------|-------|------------------|
| Requests/min | {N} | Retry con backoff |
## Manejo de Errores
| Codigo | Descripcion | Accion |
|--------|-------------|--------|
| 400 | Bad Request | Log + no retry |
| 429 | Rate Limited | Backoff exponencial |
## Multi-tenant
- Credenciales: {por tenant|globales}
- Configuracion: {por tenant|global}
## Testing
### Sandbox/Test Mode
{Como probar sin afectar produccion}
## Monitoreo
| Metrica | Descripcion | Alerta |
|---------|-------------|--------|
| Latencia | Tiempo de respuesta | >2s |
## Referencias
- [Documentacion oficial]({url})
- [Modulo relacionado](../01-modulos/SAAS-XXX.md)
---
**Ultima actualizacion:** YYYY-MM-DD
**Version:** 1.0.0
3.3 Nuevos ADRs (ADR-NNNN-titulo.md)
# ADR-NNNN: Titulo de la Decision
## Metadata
| Campo | Valor |
|-------|-------|
| ID | ADR-NNNN |
| Estado | Proposed|Accepted|Deprecated|Superseded |
| Fecha | YYYY-MM-DD |
| Supersede | N/A o ADR-XXXX |
## Contexto
{Descripcion del problema o situacion}
## Decision
{La decision tomada}
## Consecuencias
### Positivas
- {Consecuencia positiva}
### Negativas
- {Consecuencia negativa}
### Neutrales
- {Consecuencia neutral}
---
**Fecha decision:** YYYY-MM-DD
**Autores:** {Nombres}
3.4 Actualizacion de Inventarios YAML
Los inventarios DEBEN tener la siguiente estructura inicial:
---
# {TIPO} INVENTORY - Template SaaS
# Version: X.Y.Z
# Ultima actualizacion: YYYY-MM-DD
metadata:
proyecto: "template-saas"
tipo: "{MASTER|DATABASE|BACKEND|FRONTEND}"
version: "X.Y.Z"
updated: "YYYY-MM-DD"
# Campos adicionales segun tipo
resumen:
# Metricas resumidas
# Resto del contenido...
ultima_actualizacion: "YYYY-MM-DD"
actualizado_por: "{Nombre}"
4. Nomenclatura Obligatoria
4.1 Prefijos de Archivos
| Tipo | Patron | Ejemplo |
|---|---|---|
| Modulo SAAS | SAAS-NNN-nombre.md | SAAS-015-oauth.md |
| Integracion | INT-NNN-nombre.md | INT-008-analytics.md |
| ADR | ADR-NNNN-titulo.md | ADR-0006-caching.md |
| Especificacion | ET-NNN-nombre.md | ET-002-api-design.md |
4.2 Ubicacion de Archivos
| Tipo | Carpeta |
|---|---|
| Modulos SAAS | docs/01-modulos/ |
| Integraciones | docs/02-integraciones/ |
| ADRs | docs/architecture/adr/ |
| Inventarios | orchestration/inventarios/ |
| Analisis | orchestration/analisis/ |
5. Checklist de Validacion
Al crear/modificar documentos:
- Frontmatter YAML presente (si aplica)
- Tabla Metadata incluida
- Nomenclatura correcta (SAAS-NNN, INT-NNN, ADR-NNNN)
- Footer con fecha de actualizacion
- Links relativos correctos
- Actualizar _MAP.md si es nuevo archivo
- Actualizar inventario correspondiente
Al crear nuevas integraciones:
- Seccion Rate Limits
- Seccion Manejo de Errores
- Seccion Multi-tenant
- Seccion Testing
- Seccion Monitoreo
- Link a modulo SAAS relacionado
Al modificar inventarios:
- Seccion metadata: presente
- Seccion resumen: actualizada
- Conteos consistentes con otros inventarios
- version incrementada
6. Validacion Periodica
Se recomienda ejecutar validacion de cumplimiento SIMCO:
- Frecuencia: Cada sprint o cambio mayor
- Herramienta: Checklists en workspace/orchestration/checklists/
- Documentar: Resultados en orchestration/analisis/
7. Referencias
| Documento | Proposito |
|---|---|
| HERENCIA-SIMCO.md | Directivas heredadas |
| FASE-8-VALIDACION-*.md | Resultado ultima validacion |
| CHECKLIST-DOCUMENTACION-PROYECTO.md | Checklist docs |
| CHECKLIST-INVENTARIOS.md | Checklist inventarios |
| CHECKLIST-NOMENCLATURA.md | Checklist nomenclatura |
Creado: 2026-01-10 Autor: Claude Code (Estandarizacion SIMCO v3.7) Version: 1.0.0