[Docs] Armonización integral de bitácoras y protocolo ADN
This commit is contained in:
+36
-23
@@ -1,15 +1,15 @@
|
||||
# 02 - Protocolo del Proyecto: Normas y Directivas
|
||||
|
||||
Este documento establece las reglas fundamentales para la interacción, documentación y desarrollo en el proyecto `srv-NS8`.
|
||||
Este documento establece las reglas fundamentales para la interacción, documentación y desarrollo en el proyecto `srv-ns8`.
|
||||
|
||||
## 1. Idioma
|
||||
## 1. Idioma y Nomenclatura
|
||||
- **Directiva**: **Todo el contenido debe estar en español.**
|
||||
- **Nomenclatura de Nodos**: Estrictamente **minúsculas** en nombres de archivo y referencias (ej: `srv-ns8`, `pc-dasu0`, `srvv-maurik`).
|
||||
- **Alcance**:
|
||||
- Interacciones con el asistente (chat).
|
||||
- Documentación (archivos `.md`).
|
||||
- Mensajes de Commit (Git).
|
||||
- Comentarios en el código (scripts, configs).
|
||||
- Nombres de archivos y directorios (preferentemente, salvo estándares técnicos estrictos).
|
||||
|
||||
## 2. Formato de Documentación
|
||||
- **Estilo**: Markdown estándar.
|
||||
@@ -17,27 +17,40 @@ Este documento establece las reglas fundamentales para la interacción, document
|
||||
|
||||
## 3. Armonía y Auto-optimización
|
||||
- **Principio**: La documentación (ADN) debe mantenerse como un todo coherente y libre de contradicciones.
|
||||
- **Alcance Global**: Esta directiva aplica a **TODOS** los directorios del proyecto, incluyendo `adn/`, `bitacoras/`, `nodos/`, y `procedimientos/`.
|
||||
- **Directiva**:
|
||||
- **Consistencia**: No deben existir discrepancias entre diferentes hebras (archivos `.md`). Si se actualiza una definición en `01_ontologia.md`, debe reflejarse en los protocolos y bitácoras correspondientes.
|
||||
- **Consistencia**: No deben existir discrepancias entre diferentes hebras. Si se actualiza una definición en `01_ontologia.md`, debe reflejarse en los protocolos y bitácoras correspondientes.
|
||||
- **Trazabilidad**: Los IDs y estados deben ser consistentes a través del tiempo.
|
||||
- **Auto-corrección**: Al detectar una inconsistencia, es prioritario resolverla para restaurar la armonía del sistema documental.
|
||||
|
||||
## 4. Estructura de Registro (Centralizada)
|
||||
- **Principio**: **Bitácora Única**.
|
||||
- `adn/00_bitacora.md` es la **Fuente de Verdad Histórica** del Grid completo.
|
||||
- Se prohíben bitácoras dispersas en archivos individuales.
|
||||
- **Formato**: Tabla Markdown con columnas: `| Hora | Nodo | Detalle |`.
|
||||
- **Hora**: `HH:MM` (Hora Local).
|
||||
- **Nodo**: Hostname del equipo afectado (e.g. `srv-pmox1`, `srvv-SITIO`).
|
||||
- **Detalle**: Descripción consisa. Uso de Emojis para estado visual (✅, ⚠️, ❌, 🔧).
|
||||
## 4. Estructura de Bitácora (Flujo Diario)
|
||||
- **Principio**: **Orden Inverso Cronológico** (Lo más nuevo SIEMPRE ARRIBA).
|
||||
- **Archivo Diario**: `bitacoras/YYYY-MM-DD.md`.
|
||||
- **Secciones Obligatorias**:
|
||||
|
||||
### 4.1 Control de Gestión
|
||||
- **Pendientes**: Tabla de tareas por hacer (ID | NODO | DETALLE).
|
||||
- **En Proceso**: Tabla de tareas activas (ID | NODO | DETALLE).
|
||||
- **Resumen de Actividades**:
|
||||
- **Formato**: Tabla (NODO | RESUMEN INTEGRAL).
|
||||
- **Estilo**: **Narrativa Sintética e Integral**. SIN TÍTULOS NI ESTADOS en el texto. Solo la historia consolidada del día para ese nodo.
|
||||
- **Regla**: **Una sola fila por Nodo**.
|
||||
|
||||
### 4.2 Actividades Detalladas
|
||||
- **Subdivisión**: Encabezados por Nodo (`### srv-ns8`).
|
||||
- **Formato**: Tabla detallada (Tema | Detalle | Ini | Fin).
|
||||
- **Estilo**: **Narrativa Generosa y Técnica**. Aquí se explican los "qué", "cómo" y "por qué".
|
||||
- **Estados**: Uso de iconos (✅, 🧹, 🔧) para visualización rápida.
|
||||
|
||||
### 4.3 Footer de Mantenimiento (IA)
|
||||
- Al final de cada bitácora, incluir el bloque de comentarios HTML con las **Premisas de Trabajo** (Orden inverso, Nomenclatura, Flujo de Carga: Detalle -> Resumen).
|
||||
|
||||
## 5. Documentación de Nodos (Snapshots)
|
||||
- **Ubicación**: `adn/nodos/<HOSTNAME>.md`.
|
||||
- **Ubicación**: `nodos/<hostname>.md` (Raíz del proyecto).
|
||||
- **Contenido**: Representa el **Estado Actual** (Snapshot) del nodo.
|
||||
- **Actualización**: Solo se modifica cuando cambia la configuración o estado del nodo (no se usa como log histórico).
|
||||
- **Actualización**: Solo se modifica cuando cambia la configuración o estado del nodo. No duplicar información dinámica de la bitácora.
|
||||
|
||||
|
||||
|
||||
## 5. Protocolo de Seguridad de Red (Hombre Muerto)
|
||||
## 6. Protocolo de Seguridad de Red (Hombre Muerto)
|
||||
- **Problemática**: La administración remota del servidor implica el riesgo de desconexión total ante cambios erróneos en la configuración de red.
|
||||
- **Directiva**: **Toda modificación de red debe incluir un mecanismo de reversión automática.**
|
||||
- **Implementación**:
|
||||
@@ -48,22 +61,22 @@ Este documento establece las reglas fundamentales para la interacción, document
|
||||
3. **Si no hay confirmación**: Revertir cambios inmediatamente y restaurar estado anterior.
|
||||
4. **Si hay confirmación**: Hacer cambios persistentes.
|
||||
|
||||
## 6. Referencia de Estados (Bitácora)
|
||||
Para optimizar espacio horizontal, la columna `Estado` utiliza los siguientes iconos:
|
||||
## 7. Referencia de Estados (Bitácora Detallada)
|
||||
Para optimizar espacio horizontal en tablas de detalle:
|
||||
|
||||
| Icono | Significado | Descripción |
|
||||
| :---: | :--- | :--- |
|
||||
| ✅ | **Completado** | Tarea finalizada o problema solucionado exitosamente. |
|
||||
| ⏳ | **En Proceso** | Tarea iniciada pero pendiente de cierre. |
|
||||
| 🟢 | **Operativo** | Servicio funcionando correctamente tras intervención. |
|
||||
| 🔧 | **Mantenimiento** | Acción técnica de configuración o ajuste. |
|
||||
| 🧪 | **Verificado** | Validación técnica o prueba superada. |
|
||||
| ⚠️ | **Alerta** | Problema detectado, riesgo o atención requerida. |
|
||||
| 📍 | **Definido** | Hito establecido o prioridad fijada sin ejecución inmediata. |
|
||||
| 📍 | **Definido** | Hito establecido o prioridad fijada. |
|
||||
|
||||
## 7. Resguardo del Repositorio (Safeguard)
|
||||
## 8. Resguardo del Repositorio (Safeguard)
|
||||
- **Objetivo**: Asegurar la integridad y el historial de cambios del proyecto.
|
||||
- **Directiva**:
|
||||
- **Frecuencia**: Al finalizar una tarea significativa o conjunto de tareas relacionadas (hito).
|
||||
- **Alcance**: Todo cambio en `adn/`, `servicios/config`, `scripts/` y documentación `docs/`.
|
||||
- **Formato Mensaje**: `[Categoría] Descripción breve del cambio`.
|
||||
- Categorías: `Feat` (Nueva funcionalidad), `Fix` (Corrección), `Docs` (Documentación), `Refactor` (Mejora de código/estructura), `Chore` (Mantenimiento).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user