Cómo documentar un proceso de equipo en una sola página

Empieza por tareas que ocurren varias veces al mes o que generan preguntas recurrentes: dar acceso a una herramienta, publicar una actualización, preparar una entrega o atender una solicitud.

No documentes una excepción aislada solo por miedo a olvidarla. Primero identifica el flujo normal; después añade qué hacer cuando aparezca una excepción frecuente.

Cada paso debe empezar con una acción y terminar con un resultado comprobable. “Preparar la entrega” es ambiguo; “comprobar que el enlace abre y avisar al cliente” permite saber si el paso terminó.

Incluye enlaces, ejemplos o capturas solo cuando reducen una duda real. El objetivo es acortar el tiempo de ejecución, no demostrar que se ha escrito mucho.

• Cuándo usar este proceso.
• Qué necesitas antes de empezar.
• Pasos en orden.
• Qué hacer si algo falla.
• Quién mantiene la página actualizada.

La mejor revisión es pedir a alguien que no creó el proceso que lo siga. Cada pregunta que haga revela un paso implícito. Corrige la página hasta que el recorrido sea comprensible sin una llamada adicional.

Revisa la fecha y propietario de la guía. Una página breve y actualizada genera más confianza que una biblioteca enorme y obsoleta.

Disparador: el responsable ha aprobado la entrega. Entrada necesaria: archivo aprobado, destinatario verificado y permiso para compartir. Paso 1: abre el archivo y comprueba nombre y versión. Paso 2: crea el enlace con el acceso mínimo necesario. Paso 3: comprueba el acceso desde un contexto equivalente al del destinatario. Paso 4: envía el enlace y registra fecha, versión y responsable.

Resultado esperado: el destinatario correcto puede acceder al archivo correcto. Excepción: si la prueba de acceso falla, no envíes el enlace ni lo abras a todo el mundo como atajo. Revisa permisos o consulta al responsable. Si el cliente necesita un formato distinto, vuelve al paso de aprobación antes de reemplazar el archivo.

La comprobación no consiste en abrir el enlace desde la cuenta propietaria: esa cuenta podría verlo aunque nadie más tuviera permiso. Usa una cuenta de prueba autorizada o el procedimiento de verificación de la herramienta, sin compartir credenciales reales.

Pide a alguien que siga el procedimiento con un archivo ficticio y anota cada duda literal. «¿Dónde está el aprobado?» exige añadir la ubicación de entrada; «¿a quién aviso?» exige un responsable. Cuando cambie la herramienta o el modelo de permisos, repite esta prueba. Registrar una fecha nueva sin comprobar el recorrido no equivale a actualizar la documentación.

Ejercicio ficticio: el procedimiento consiste en enviar un informe aprobado a un cliente. El autor sabe dónde están los archivos, pero una persona nueva solo dispone de la página del procedimiento. Una prueba útil incluye fallos deliberados, no únicamente el recorrido que ya funciona.

Coloca cada punto de parada antes de la acción que podría causar el problema. El procedimiento debe indicar qué queda hecho, qué falta y desde dónde continuar. Registrar un paso no exige copiar datos confidenciales al manual: basta con una referencia al sistema que conserva la evidencia con sus permisos.

Desliza la tabla para ver todas las columnas.

Si no puedes verificar un permiso sin usar la cuenta del autor, la prueba de acceso está incompleta. No compartas contraseñas ni hagas público el archivo para superar la comprobación.

• Una persona distinta puede encontrar la entrada y reconocer el final.
• Cada excepción tiene responsable y siguiente paso, no solo un aviso rojo.
• La prueba registra qué instrucción cambió, no una fecha de revisión ficticia.