Crear procedimiento¶
Guía para crear nuevos procedimientos en Nexus.
Acceder al formulario¶
- Ve a Procedimientos
- Haz clic en + Crear
- Se abre el formulario de creación
Formulario de creación¶
┌─────────────────────────────────────────────────────────────────┐
│ Crear Procedimiento │
├─────────────────────────────────────────────────────────────────┤
│ │
│ ID * │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ PROC- │ │
│ └─────────────────────────────────────────────────────────┘ │
│ ℹ️ Formato: PROC-XX (número de 2 dígitos) │
│ │
│ Título * │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ │ │
│ └─────────────────────────────────────────────────────────┘ │
│ │
│ Categoría * │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ Seleccionar categoría... ▼ │ │
│ └─────────────────────────────────────────────────────────┘ │
│ │
│ Descripción │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ Breve descripción del procedimiento... │ │
│ └─────────────────────────────────────────────────────────┘ │
│ │
│ [Cancelar] [Siguiente: Contenido →] │
│ │
└─────────────────────────────────────────────────────────────────┘
Campos del formulario¶
ID (requerido)¶
Identificador único del procedimiento.
| Formato | Ejemplo | Categoría |
|---|---|---|
| PROC-0X | PROC-05 | Gestión/Docs |
| PROC-1X | PROC-15 | Base de datos |
| PROC-2X | PROC-21 | Despliegue |
| PROC-3X | PROC-32 | Testing |
| PROC-4X | PROC-45 | Seguridad |
Numeración
El número debe corresponder a la categoría. Consulta Categorías para los rangos.
Título (requerido)¶
Nombre descriptivo y claro:
Buenos títulos: - "Deploy a Producción" - "Revisión de Performance de Base de Datos" - "Proceso de Hotfix"
Malos títulos: - "Proc 21" - "Deploy" - "Hacer cosas"
Categoría (requerido)¶
Selecciona la categoría apropiada según el rango del ID.
Descripción¶
Breve explicación del propósito del procedimiento (opcional pero recomendado).
Escribir el contenido¶
Después de completar la información básica, se abre el editor de contenido:
┌─────────────────────────────────────────────────────────────────┐
│ Contenido del Procedimiento [👁 Preview] │
├─────────────────────────────────────────────────────────────────┤
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ # PROC-21: Deploy a Producción │ │
│ │ │ │
│ │ ## Objetivo │ │
│ │ Desplegar la aplicación en producción de forma segura. │ │
│ │ │ │
│ │ ## Pre-requisitos │ │
│ │ - [ ] Tests pasando │ │
│ │ - [ ] Code review aprobado │ │
│ │ │ │
│ │ ## Pasos │ │
│ │ ### 1. Verificación │ │
│ │ ... │ │
│ └─────────────────────────────────────────────────────────┘ │
│ │
│ [← Volver] [Crear procedimiento] │
│ │
└─────────────────────────────────────────────────────────────────┘
Estructura recomendada¶
# PROC-XX: Título del Procedimiento
## Objetivo
[Qué se logra con este procedimiento]
## Pre-requisitos
- [ ] Requisito 1
- [ ] Requisito 2
- [ ] Requisito 3
## Pasos
### 1. Primer paso
Descripción detallada del primer paso.
**Verificación:** Cómo saber si se completó correctamente.
### 2. Segundo paso
Descripción detallada del segundo paso.
**Verificación:** Cómo saber si se completó correctamente.
### 3. Tercer paso
Descripción detallada del tercer paso.
## Decisiones
### Si [condición A]
1. Hacer X
2. Hacer Y
### Si [condición B]
1. Hacer Z
## Rollback / Recuperación
Pasos para revertir si algo sale mal.
## Resultado esperado
[Qué debe haber sucedido al terminar]
## Notas adicionales
- Nota 1
- Nota 2
Elementos útiles en Markdown¶
Checklists¶
Advertencias¶
!!! warning "Precaución"
Mensaje de advertencia importante.
!!! tip "Consejo"
Sugerencia útil.
!!! danger "Peligro"
Acción que puede causar problemas.
Código¶
Tablas¶
| Paso | Acción | Responsable |
|------|--------|-------------|
| 1 | Backup | DBA |
| 2 | Deploy | DevOps |
Ejemplo completo¶
# PROC-21: Deploy a Producción
## Objetivo
Desplegar cambios en el entorno de producción minimizando
el riesgo de downtime.
## Pre-requisitos
- [ ] Todos los tests pasan en CI
- [ ] Pull request aprobado y mergeado
- [ ] Backup de base de datos realizado (< 24h)
- [ ] Slot de deploy reservado en calendario
## Pasos
### 1. Preparación
1. Verificar estado del CI en main
2. Confirmar que no hay otros deploys en curso
3. Notificar en #deploys que se inicia el proceso
**Verificación:** CI en verde, canal notificado
### 2. Backup pre-deploy
1. Crear snapshot de la base de datos
2. Guardar estado actual de la configuración
3. Documentar versión actual desplegada
**Verificación:** Snapshot creado y verificable
### 3. Despliegue
1. Ejecutar: `./scripts/deploy.sh production`
2. Monitorear logs durante el proceso
3. Esperar mensaje de confirmación
**Verificación:** Script termina sin errores
### 4. Verificación post-deploy
1. Ejecutar tests de smoke
2. Verificar endpoints críticos
3. Revisar métricas en Grafana
**Verificación:** Todos los checks pasando
### 5. Comunicación
1. Actualizar changelog
2. Notificar en #deploys el éxito
3. Cerrar ticket asociado
## Rollback
Si algo falla durante o después del deploy:
1. Ejecutar: `./scripts/rollback.sh production`
2. Restaurar snapshot de BD si es necesario
3. Notificar incidente en #incidents
4. Crear post-mortem
## Resultado esperado
- Aplicación actualizada a la última versión
- Sin errores en logs
- Métricas normales
- Usuarios no afectados
## Notas
- Evitar deploys los viernes
- Preferir horarios de baja actividad
- Tener a alguien disponible para soporte
Guardar y publicar¶
- Revisa el contenido con Preview
- Verifica que no hay errores de formato
- Haz clic en Crear procedimiento
- El procedimiento aparece en la lista
Después de crear¶
- Asigna tareas: Asocia el procedimiento a tareas relevantes
- Prueba: Ejecuta una tarea que use el procedimiento
- Ajusta: Modifica según los resultados
- Sincroniza: Si quieres guardarlo en archivos
Siguiente: Editor - Cómo editar procedimientos existentes.