Documentar la configuración de tu sitio web (para que no se pierda nada)
Jazmie JamaludinAquí hay una pequeña historia de terror que les sucede a los propietarios de sitios web todo el tiempo. Algo se rompe. Tal vez un correo electrónico deja de llegar, o una página se queda en blanco, o aparece un aviso de renovación de un servicio que nadie reconoce. Necesita arreglarlo rápido, así que busca el inicio de sesión, la cuenta, la persona que lo configuró. Y no encuentra nada. Ni notas, ni lista, ni registro. El conocimiento residía enteramente en la cabeza de alguien, y esa persona se ha marchado. Ahora, una solución de cinco minutos se convierte en una investigación de cinco días.
Este es el problema silencioso y evitable que la buena documentación resuelve. En esta guía, aprenderá qué significa realmente la documentación de un sitio web, por qué es una de las partes más valiosas y, sin embargo, más descuidadas de la gestión de un sitio, exactamente qué escribir y cómo mantener sus notas útiles sin que se convierta en una tarea ardua. El objetivo es simple: si algo sale mal, o si alguien nuevo toma el control, nada importante se pierde.
Lo que la documentación realmente significa aquí
La documentación suena intimidante, como algo con lo que solo los grandes equipos técnicos se preocupan. No lo es. En términos sencillos, la documentación de un sitio web es simplemente un registro escrito de cómo está construido su sitio y quién es responsable de cada parte. Dónde está registrado el dominio. Quién aloja el sitio. Qué herramientas y complementos están instalados. Dónde se encuentran los inicios de sesión importantes. Qué hacer cuando cosas específicas se rompen.
Piense en ello como el manual de instrucciones y la lista de contactos de su sitio web, lo que le daría a un extraño tranquilo y competente y le diría: "aquí tiene todo lo que necesita para mantener esto funcionando". No necesita ser elegante. Un documento claro y bien organizado que alguien pueda leer y seguir supera a un sistema elaborado que nadie mantiene. El valor reside enteramente en tenerlo, no en lo pulido que parezca.
Por qué se omite
La documentación es la tarea clásica que nunca parece urgente. El sitio está funcionando, usted recuerda cómo encaja todo, y escribirlo parece un esfuerzo sin recompensa inmediata. Así que se pospone, una y otra vez, hasta el día en que la necesita desesperadamente y no está allí. El punto clave es que el momento en que necesita la documentación es exactamente el momento en que es demasiado tarde para escribirla. Debe hacerlo mientras las cosas están en calma, como seguro contra el día en que no lo estén.
Qué anotar
La pregunta más común es simplemente, ¿qué debe contener? Una buena regla general es esta: cualquier cosa que, si se pierde, le causaría dolor o pánico. Esto generalmente se divide en un puñado de categorías claras. Repasémoslas, porque una vez que vea la lista, la tarea deja de sentirse vaga y comienza a sentirse factible.
Primero, los fundamentos: dónde está registrado su nombre de dominio, dónde está alojado su sitio y cuándo se renuevan. Un sorprendente número de desastres de sitios web se debe a que un dominio o una cuenta de alojamiento caducan silenciosamente porque nadie sabía que era el momento. Nuestra guía sobre la auditoría de la salud de su sitio cubre cómo estos fundamentos encajan en el panorama general de mantener un sitio sano.
| Categoría | Qué registrar |
|---|---|
| Dominio | Dónde está registrado y la fecha de renovación |
| Alojamiento | El proveedor, el plan y cómo contactar con el soporte |
| Inicios de sesión y acceso | Quién tiene las claves, almacenadas en un gestor de contraseñas |
| Herramientas y complementos | Qué está instalado y qué hace cada uno |
| Copias de seguridad | Dónde se almacenan y cómo restaurarlas |
| Personas | A quién llamar para cada cosa, con detalles de contacto |
Segundo, el acceso. Necesita saber qué cuentas controlan el sitio y quién puede acceder a ellas, sin escribir las contraseñas reales en un documento simple. La herramienta adecuada aquí es un gestor de contraseñas, que almacena las credenciales de forma segura y le permite compartir el acceso de forma segura. Su documentación debe indicar dónde se encuentran los inicios de sesión, no listarlos abiertamente.
Herramientas, complementos y por qué existen
La mayoría de los sitios acumulan una colección de herramientas y complementos con el tiempo, cada uno instalado por una razón que tenía sentido en ese momento. Seis meses después, nadie recuerda por qué está uno en particular, si es seguro eliminarlo o qué se rompería si desapareciera. Anotar lo que hace cada complemento y por qué se añadió, convierte una pila misteriosa en un inventario manejable. Esto se combina directamente con rutinas de mantenimiento disciplinadas, donde se revisa regularmente lo que está instalado en lugar de dejar que crezca sin control.
Documentación de sus copias de seguridad y recuperación
De todo lo que anote, sus notas de copia de seguridad y recuperación pueden ser las más importantes. Una copia de seguridad que no puede encontrar o restaurar apenas es una copia de seguridad. Su documentación debe indicar claramente dónde se almacenan las copias de seguridad, con qué frecuencia se realizan y los pasos exactos para restaurar el sitio si ocurre un desastre. Idealmente, escriba estos pasos como si fueran para alguien que nunca lo ha hecho antes, porque el día que los necesite puede estar estresado, apurado o puede que no sea usted en absoluto.
Aquí es donde la documentación se conecta con la idea más amplia de estar preparado para lo peor. Un sitio bien documentado se recupera más rápido de cualquier incidente, porque las personas que lo arreglan no están también jugando a ser detectives. Saber dónde está todo, quién lo controla y cómo volver a colocarlo es la mitad de la batalla cuando algo sale seriamente mal. Las notas tranquilas y claras convierten una crisis en un procedimiento.
Registro de sus cambios a lo largo del tiempo
Más allá de los hechos estáticos, ayuda llevar un registro sencillo y continuo de los cambios significativos que realice en el sitio. Cuando actualice el tema, instale una nueva herramienta, cambie una configuración clave o migre a un nuevo alojamiento, anote lo que hizo y cuándo. Este registro de cambios es oro cuando algo se rompe, porque la primera pregunta útil es casi siempre "¿qué cambió recientemente?". Si tiene una respuesta escrita, a menudo puede identificar la causa en minutos en lugar de horas.
Este hábito es más importante cuando realiza cambios grandes. Antes de una actualización o rediseño importante, es aconsejable probar en una copia separada de su sitio primero, y anotar exactamente lo que alteró. Nuestra guía sobre sitios de staging explica cómo probar los cambios de forma segura, y un buen registro de cambios registra el resultado para que tenga un rastro que seguir más tarde. La documentación y la gestión cuidadosa de los cambios se refuerzan mutuamente.
Una estructura simple para empezar
Una de las razones por las que nunca se escribe la documentación es que una página en blanco intimida. Ayuda enormemente empezar con una forma ya hecha en lugar de inventar una. Así que aquí tiene una estructura simple que puede copiar en un documento nuevo hoy mismo y rellenar con el tiempo. Cada encabezado es solo un lugar para colocar los hechos relevantes, y puede desarrollarlos gradualmente en lugar de todos a la vez.
Comience con una descripción general: un párrafo en lenguaje sencillo que describa qué es el sitio, para qué sirve y quién lo posee. Luego, una sección de fundamentos que cubra el dominio y el alojamiento, con las fechas de renovación claramente anotadas. Continúe con una sección de acceso que indique dónde se encuentran los inicios de sesión y enumere quién los tiene, nunca las contraseñas en sí. Agregue un inventario de herramientas y complementos instalados con una línea sobre lo que hace cada uno y por qué existe.
Después de eso, una sección de copias de seguridad y recuperación: dónde se almacenan las copias de seguridad, con qué frecuencia se ejecutan e instrucciones de restauración paso a paso escritas para un principiante nervioso. Luego, una sección de contactos que enumere a quién llamar para cada cosa, desde la línea de soporte de su proveedor de alojamiento hasta el freelancer que construyó una característica complicada. Finalmente, un registro de cambios continuo donde anote los cambios significativos con fechas. Ese es todo el esqueleto. Rellenarlo es mucho menos desalentador que enfrentarse a una página vacía, e incluso una versión a medio completar es un activo genuino.
Mantenga el lenguaje sencillo en todo momento. La prueba de una buena documentación es si alguien que nunca ha visto su sitio podría leerla y orientarse. Evite abreviaturas que solo usted entienda, explique todo lo que pueda ser obvio para usted pero misterioso para un recién llegado, y resista la tentación de elaborarlo. Un documento claro y aburrido que cualquiera puede seguir vale diez documentos ingeniosos que solo su autor puede decodificar.
Dónde guardarlo y cómo compartirlo
Su documentación solo es útil si las personas adecuadas pueden encontrarla cuando la necesitan, y las personas equivocadas no pueden. Guárdela en un lugar central y duradero, no enterrada en los archivos personales de una persona o en una sola computadora portátil que podría perderse. Un documento compartido en una ubicación segura y con copia de seguridad funciona bien. Solo asegúrese de que más de una persona de confianza sepa dónde está y pueda acceder a ella.
Mantenga las partes sensibles separadas. Las contraseñas reales pertenecen a un gestor de contraseñas, nunca en el documento principal. La documentación puede decir "los inicios de sesión se almacenan en nuestro gestor de contraseñas, y estas personas tienen acceso", lo cual es seguro compartir más ampliamente. Dividir las instrucciones abiertas de las credenciales secretas le permite entregar la documentación a un nuevo ayudante sin exponer las llaves del reino.
Haga que forme parte de las transferencias
La verdadera prueba de la documentación llega cuando alguien nuevo toma el relevo, ya sea un nuevo miembro del personal, un autónomo o una agencia diferente. Una buena documentación facilita la transferencia: se les indica el documento, se orientan rápidamente y nada se pierde. Esto es especialmente valioso cuando se decide entre gestionar las cosas usted mismo y buscar ayuda externa, una elección explorada en nuestra guía sobre mantenimiento por cuenta propia frente a mantenimiento gestionado.
Mantener la documentación viva
El mayor modo de fallo de la documentación no es no tenerla; es tener notas obsoletas que confunden más de lo que ayudan. Un documento que dice que su sitio está alojado en un lugar donde ya no está, o que enumera a una persona que se fue hace dos años, puede enviar a un ayudante en pánico por un camino completamente equivocado. La documentación obsoleta puede ser peor que no tenerla, porque es engañosa.
La solución es revisarla y actualizarla regularmente. Conéctela a su rutina: cada vez que realice sus comprobaciones periódicas del sitio, eche un vistazo a la documentación y actualice cualquier cosa que haya cambiado. Incorporar esto a un programa de mantenimiento recurrente mantiene las notas fiables con muy poco esfuerzo. Unos minutos durante cada revisión es todo lo que se necesita para mantener su manual actualizado con la realidad.
La documentación también facilita la evaluación y el presupuesto del soporte continuo, porque puede ver claramente lo que implica su sitio. Cuando comprende cada parte móvil, las conversaciones sobre los costos de mantenimiento y la elección de un plan de mantenimiento se vuelven mucho más fundamentadas. Sabe por qué y por qué está pagando.
Empieza poco a poco, empieza hoy
Si todo esto le parece mucho, aquí tiene la parte alentadora: no tiene que hacerlo todo a la vez, y un documento parcial es infinitamente mejor que nada. Abra un documento nuevo ahora mismo y anote solo tres cosas: dónde está registrado su dominio, quién aloja su sitio y quién lo configuró todo. Eso por sí solo salvaría a muchos propietarios de sitios de su peor día. Añada a él cada vez que toque el sitio, y en unas pocas semanas tendrá un registro realmente útil.
La documentación es una de esas tareas poco atractivas que le devuelve precisamente cuando más necesita ayuda y menos lo espera. Cuesta un poco de tiempo ahora y ahorra un enorme estrés más tarde. Escríbalo mientras todo está en calma, manténgalo actualizado y guárdelo en un lugar seguro y compartido. Entonces, pase lo que pase, nada importante se pierde realmente. Si desea ayuda para capturar su configuración correctamente, siempre puede ponerse en contacto.