Este es un texto traducido automáticamente que puede contener errores!
Una buena documentación es la diferencia entre recordar cómo funcionan las cosas y quedarse atascado a las 23 en punto un domingo porque el servidor está inactivo y nadie recuerda cómo se configuró. La documentación puede que no sea la parte más emocionante de las operaciones de TI, pero es una de las más importantes.
¿Por qué documentar?
| Razón | Explicación |
|---|---|
| Memoria | No recordarás todo en seis meses, y tampoco necesitas hacerlo |
| Colaboración | Otros deben poder entender lo que has hecho sin preguntarte |
| Resolución de problemas | Cuando algo sale mal, es invaluable saber qué es normal |
| Reconstrucción | Si un servidor muere, necesitas saber exactamente cómo estaba configurado |
| Trazabilidad | ¿Qué se cambió, cuándo y por quién? |
Skriv dokumentasjonen for “fremtidig deg”
La mejor regla general: escribe como si estuvieras explicándoselo a ti mismo dentro de seis meses. Así te aseguras de incluir suficientes detalles sin complicar demasiado las cosas.
Tipos de documentación en la operación de TI
Mapa de la red
Un mapa de la red muestra la estructura física y/o lógica de la red. Puede ser desde un simple boceto hasta un diagrama detallado con VLAN, direcciones IP y reglas de firewall.
Un buen mapa de la red debe incluir:
- Todos los dispositivos de red (switches, routers, firewall, puntos de acceso)
- Estructura VLAN con subred
- Direcciones IP para dispositivos importantes (servidores, puerta de enlace)
- Conexiones entre dispositivos
Plan de IP
Un plan de IP es una descripción general de cómo se distribuyen las direcciones IP en la red. Te ayuda a mantener el orden y evitar conflictos (dos dispositivos con la misma dirección).
Ejemplo:
| VLAN | Nombre | Subred | Puerta de enlace | Rango DHCP | Notas |
|---|---|---|---|---|---|
| 10 | Administración | 10.0.10.0/24 | 10.0.10.1 | .100 - .200 | Acceso limitado |
| 20 | Empleados | 10.0.20.0/24 | 10.0.20.1 | .100 - .250 | |
| 30 | Estudiantes | 10.0.30.0/24 | 10.0.30.1 | .100 - .250 | Solo internet |
| 50 | Servidores | 10.0.50.0/24 | 10.0.50.1 | Ninguno (estático) | Direcciones IP fijas |
Direcciones estáticas:
| Dirección IP | Dispositivo | Rol |
|---|---|---|
10.0.50.10 | web-01 | Nginx |
10.0.50.11 | db-01 | PostgreSQL |
10.0.50.12 | monitoring-01 | Grafana + Loki |
10.0.50.20 | proxmox | Hipervisor |
Listas de verificación
Las listas de verificación aseguran que nada se olvide. Son especialmente útiles para tareas que realizas con menos frecuencia, como configurar un nuevo servidor o realizar una revisión de seguridad.
Ejemplo: Lista de verificación para un nuevo servidor Linux:
- Instalar sistema operativo (Debian/Ubuntu)
- Actualizar todos los paquetes (
sudo apt update && sudo apt upgrade) - Crear usuario con acceso sudo
- Desactivar inicio de sesión root a través de SSH
- Configurar firewall (
ufw) - Instalar software necesario
- Configurar copia de seguridad
- Documentar el servidor en el plan de IP
- Probar que el servicio funciona
Documentación de cambios
Cada vez que realice un cambio en un entorno de producción (servidor, red, servicio), debe documentarlo. Un registro simple puede ser suficiente:
## Endringslogg
### 2026-04-14 - Oppgradert Nginx
- **Qué:** Actualizado Nginx de 1.24 a 1.26
- **Por qué:** Actualización de seguridad (CVE-2025-XXXX)
- **Quién:** Ola
- **Resultado:** OK, sin tiempo de inactividad
### 2026-04-10 - Nytt VLAN for IoT
- **Qué:** Creado VLAN 40 para dispositivos IoT
- **Por qué:** Aislar IoT del resto de la red
- **Quién:** Kari
- **Resultado:** OK, todas las impresoras movidas a VLAN 40
Bruk Git!
Si escribes la documentación en archivos Markdown (recomendado), puedes controlarlas versiones con Git. Entonces tendrás automáticamente un historial de todos los cambios, y podrás ver quién cambió qué y cuándo.
Documentación de Operaciones
La documentación de operaciones describe cómo funciona un sistema en su estado actual:
| Qué | Ejemplo |
|---|---|
| Arquitectura del sistema | “Ejecutamos Proxmox con 3 VMs: web, db, monitoring” |
| Información de acceso | “SSH a través del puerto 22, solo desde VPN” |
| Rutinas de copia de seguridad | “Copia de seguridad diaria a las 02:00 a un disco externo” |
| Información de contacto | “En caso de problemas, contactar a Ola (admin)” |
| Pasos de recuperación | “Reiniciar con: sudo systemctl restart nginx“ |
Herramientas para la documentación
| Herramienta | Para qué se utiliza | Ventajas |
|---|---|---|
| Markdown | Texto con formato simple | Ligero, portátil, funciona con Git |
| draw.io | Diagramas y mapas de red | Gratis, visual, exporta a imagen |
| Obsidian | Aplicación de notas con Markdown y enlaces | Bueno para base de conocimiento personal |
| MkDocs | Publica Markdown como página web | Documentación profesional |
| Git/GitHub | Control de versiones de la documentación | Historial, colaboración, copia de seguridad |
Tarea 1 - Crea un mapa de red simple
Usa draw.io (gratis) para dibujar la red en casa o en la escuela:
- Comienza con la conexión a Internet y el enrutador
- Agrega conmutadores y puntos de acceso
- Dibuja servidores, PC y otros dispositivos
- Escribe las direcciones IP donde las conozcas
No tiene que ser perfecto. El objetivo es empezar a pensar visualmente sobre la red.
Tarea 2 - Crea tu propia lista de verificación
Piensa en algo que haces regularmente con IT (por ejemplo, configurar una nueva VM, instalar una máquina de desarrollo o configurar VS Code). Escribe una lista de verificación para el proceso:
- ¿Cuáles son todos los pasos?
- ¿Qué olvidas con más frecuencia?
- ¿Puedes simplificar algunos pasos?
Guárdala en un documento Markdown para que puedas usarla la próxima vez.
Tarea 3 - Documenta uno de tus servicios
Elige un servicio que hayas configurado (una VM, un contenedor Docker, un servidor web) y escribe una breve documentación operativa:
- ¿Qué hace el servicio?
- ¿Cómo lo inicias/detienes?
- ¿Cuál es la dirección IP y el puerto?
- ¿Existe una copia de seguridad?
Escríbelo en Markdown y colócalo en un repositorio Git.
Resumen
- Documentos para tu yo futuro: Escribe como si estuvieras explicando a alguien que no sabe nada
- Mapas de red y planes de IP proporcionan una visión general de la infraestructura
- Listas de verificación aseguran que nada se olvide al realizar tareas repetitivas
- Registros de cambios rastrean qué se hizo, cuándo y por quién
- Documentación operativa describe cómo funcionan los sistemas actualmente
- Usa Markdown + Git para una documentación sencilla y con control de versiones