Close

Cómo dominar la documentación interna

Extrae información del cerebro de los miembros de tu equipo para guardarla en un lugar seguro

Buscar temas
Ilustración de dos personas editando una página de Confluence

¿Conoces a algún compañero de trabajo que lleve años en el equipo, que gestione de forma independiente muchísimas tareas y que siempre sea el recurso al que todos acuden para preguntas rápidas?

Pues ahora imagínate que acabara de presentar su carta de dimisión.

Dos semanas no es tiempo suficiente para que otra persona se ponga al día en todo lo que hace un veterano. Cuando se vaya, perderéis una tonelada de conocimientos y experiencia en los que tu equipo se ha acostumbrado a confiar.

¡Lo sentimos si de repente te ha entrado ansiedad! Ahora bien, ese nudo que sientes en el estómago demuestra la importancia de la documentación interna.

Analicemos en mayor profundidad todo lo que debes saber para ponerte en marcha y/o perfeccionar tu proceso antes de que sea necesario. El mejor momento para reparar un tejado con goteras es cuando hace sol.

¿En qué consiste la documentación interna?

La documentación interna es la práctica de crear y conservar procesos y procedimientos claramente detallados para que puedan consultarlos los miembros internos del equipo.

Se diferencia de la documentación externa en que (como su propio nombre indica) la utilizan personas ajenas a tu organización. Un ejemplo podría ser el manual que les das a tus clientes.

No es ningún secreto que la documentación interna puede acabar siendo un poco confusa, ya que es algo que se comenta mucho en lo referente a los equipos de desarrollo y de TI, que deben documentar meticulosamente el código del software y las aplicaciones que compilan.

No obstante, aunque podría tener raíces hasta cierto punto técnicas, la documentación es una práctica que puede ser útil en toda la empresa, desde el equipo de Recursos Humanos hasta el de Atención al Cliente.

Tipos de documentación interna

La mayor parte de lo que vamos a comentar en este artículo está ligado a la documentación de los procesos: dejar constancia de las fases de las tareas o rutinas de las que son responsables los miembros de tu equipo.

Sin embargo, este no es en absoluto el único tipo de documentación interna. Entre otros tipos habituales se incluyen los siguientes:

  • La documentación del equipo: Esta es información relacionada con el trabajo que lleva a cabo un equipo. Piensa en cosas como objetivos, los planes de proyecto, las planificaciones del equipo, los informes de estado, las notas de las reuniones, etc.
  • La documentación de referencia: La documentación de los procesos se encuadra dentro de esta categoría más amplia. La documentación de referencia sirve para instruir al personal sobre las cuestiones, procesos y políticas importantes (como, por ejemplo, cómo pedir un día de vacaciones).
  • La documentación del proyecto: Este tipo de documentación es específico de un proyecto en particular. Puede incluir cosas como propuestas, requisitos de los productos, directrices de diseño, bocetos y hojas de ruta, entre otras.

En este artículo, vamos a centrarnos principalmente en la documentación de referencia (y, en concreto, en la documentación de los procesos), pero conocer estos otros tipos no deja de aportar un contexto útil.

La documentación interna es la práctica de crear y conservar procesos y procedimientos claramente detallados para que puedan consultarlos los miembros internos del equipo.

Por qué usar la documentación

Son demasiadas las empresas que no se dan cuenta de la importancia de la documentación interna (hasta que les cae una crisis sobre sus cabezas y les sobreviene el caos). De hecho, según una encuesta de BPTrends, solo el 4 % de las empresas afirma documentar siempre sus procesos. Otro 50 % admite que solo lo hace de vez en cuando.

Deja que nos pongamos un poquito vehementes: no formes parte de esa estadística. La documentación interna es realmente importante por una serie de distintos motivos.

Haz más desperdiciando menos

Pongamos que vas a asumir el cometido de un compañero de trabajo que consiste en enviar un resumen mensual a tus clientes. ¿Qué sería más rápido: intentar hacerlo por tu cuenta dando palos de ciego, o seguir unas instrucciones detalladas y unos pantallazos que te enseñaran exactamente cómo extraer y distribuir esa información?

Obviamente, la segunda opción, ¿verdad?

La documentación interna actúa como un recurso para los procesos comunes (ya se trate de rellenar informes de gastos o de programar una reunión con un cliente) al que los miembros del equipo pueden acudir para realizar las tareas de manera eficiente. Eso es mucho mejor (por no decir menos estresante) que abordarlos cual elefante en una cacharrería con una tonelada de conjeturas.

Lleva la incorporación de trabajadores a un nivel superior

Según un estudio de Gallup, por desgracia, solo el 12 % de los empleados declara estar muy de acuerdo en que su organización hace un trabajo estupendo a la hora de incorporar a nuevos empleados.

Eso resulta frustrante, ya que hay pocas cosas peores que empezar en un trabajo nuevo y sentir que tienes que apañártelas por tu cuenta.

Las prácticas de documentación interna eficaces aportan a los nuevos miembros del equipo una fuente de conocimientos a la que pueden acudir para abordar con seguridad diversos aspectos de su nueva función.

Obviamente, la documentación no es un sustituto de factores como la mentoría y el contacto personal durante el frágil periodo de incorporación, pero sí es, sin lugar a dudas, un complemento útil y una forma estupenda de darle de inmediato a los nuevos miembro del equipo un poco de autonomía y de independencia.

Posibilita el intercambio de conocimientos

Con demasiada frecuencia, la información y el saber hacer importantes permanecen aislados en los cerebros de cada uno de los miembros de tu equipo. En tales casos, te enfrentas a un problema gordo cuando estas personas se van, sobre todo porque el 42 % de los participantes en una encuesta admitieron que los conocimientos que necesitan en su trabajo son únicos.

Por eso, lo normal debería ser extraer y documentar estos conocimientos privilegiados de los cerebros de la gente. De este modo, se derriban las unidades aisladas, se estimula el intercambio de conocimientos y a tu equipo le resulta más fácil desempeñar su trabajo correctamente cuando se producen cambios imprevistos y ausencias.

Prácticas recomendadas para la gestión de documentos

Ahora que conoces el porqué, pasemos al cómo.

Sigue estas prácticas recomendadas para crear una documentación interna que ayude de verdad a tu equipo, en vez de frustrarlo aún más.

Facilita el cumplimiento

Nadie va a mirar tu documentación si consideran que necesitan un diccionario para entenderla. Simplifica y abstente de usar demasiada jerga, demasiadas siglas o un lenguaje complejo. Asegúrate de utilizar también muchos encabezados de sección y viñetas para que los documentos se puedan leer por encima y no resulten abrumadores.

Captura de pantalla de la página de Confluence

Utiliza ejemplos y elementos gráficos

Nada da tanta claridad como añadir unos cuantos ejemplos y elementos gráficos, así que asegúrate de incorporarlos en lugar de depender únicamente del texto. En vez de limitarte explicar cómo llevar a cabo una fusión de correos de invitación para el convite anual de la empresa, muestra el proceso paso a paso con pantallazos de la última vez que lo hiciste.

Hazla accesible

Si quieres que la gente la use, tienen que poder encontrarla. La documentación interna debería ser accesible, no quedar enterrada entre decenas de carpetas. Esa es una de las ventajas de Confluence: que utiliza una estructura abierta de árbol de páginas, lo que significa que los documentos no se perderán en un sinfín de capas de carpetas. A la hora de ponerle un nombre a tus archivos, piensa en los términos que usarán tus compañeros de equipo para intentar encontrar esas instrucciones. Si empleas un lenguaje sencillo y directo, se lo pondrás mucho más fácil para descubrir lo que necesitan.

Entra en los suficientes detalles

Cuando conoces a fondo un proceso, es fácil saltarse pasos y pasar por alto particularidades importantes. Ante la duda, opta por dar muchos detalles. Después, para asegurarte, pídele a alguien que no esté familiarizado con el proceso que revise el documento e intente seguirlo. Si se atasca, céntrate en ese punto y reflexiona sobre cómo dejar más claras esas cuestiones.

Las prácticas de documentación interna eficaces aportan una fuente de conocimientos a los nuevos miembros del equipo.

Abre la puerta a las contribuciones

Por si con el consejo anterior no ha quedado suficientemente claro, no hace falta que seas solo tú quien se ocupe de la documentación interna. Incluye a los miembros de tu equipo para plasmar el cerebro de tu empresa en una página y pídeles que documenten algunos de los procesos que suelen hacer ellos mismos. Al fin y al cabo, ellos son quienes están más familiarizados con esas tareas.

Usa documentos vivos

Las cosas cambian rápidamente dentro de tu empresa y tu equipo. El mero hecho de dejar algo por escrito no significa que sea inamovible. Lo último que te interesa hacer cuando cambie un proceso (por ejemplo, que vayas a usar un nuevo software o que hayas simplificado algunos pasos) es rehacer o modificar un PDF u otro recurso estático. Debes utilizar documentos dinámicos (por cierto, Confluence viene de perlas para ello) para que tu documentación interna pueda evolucionar con mayor facilidad al mismo ritmo que tu equipo. Además, aportan la ventaja adicional de que facilitan mucho la contribución por parte de los miembros de tu equipo.

Creación de un proceso de documentación interna

Contar con un proceso de documentación interna sofisticado (¡con plantillas!) puede ayudarte a que te cueste mucho menos trabajo elaborar la documentación y aumentar su homogeneidad en toda la empresa. Existe un proceso para la creación de procesos, y ahí es donde entramos nosotros. Sigue estos pasos.

1. Identifica los procesos clave

Somos grandes devotos de la documentación, pero eso no quiere decir que convenga dejar constancia pormenorizada de absolutamente todo. No hay ninguna necesidad de ponerse estupendos con los procedimientos de eventos fortuitos o que solo se harán una vez.

Para empezar, establece unas cuantas reglas básicas para determinar lo que documentarás. ¿Un proceso tiene que producirse un número determinado de veces (pongamos, por ejemplo, tres) para que lo consideres digno de documentar? ¿Tiene que hacerse con frecuencia (por ejemplo, al menos una vez al mes)?

Si te marcas el propósito de documentarlo todo, pecarás un poco de exceso de ambición y te expondrás a que el objetivo te acabe sobrepasando. Por eso, es inteligente establecer algunos criterios de lo que merece la pena documentar.

2. Crea una plantilla estándar

Puedes ahorrarte tiempo y garantizar la homogeneidad de tu documentación creando una plantilla que todo el mundo pueda usar. Asegúrate de que la plantilla incluya campos para lo siguiente:

  • Una breve descripción del motivo por el que existe este proceso
  • Quiénes son los actores clave en este proceso
  • Lo que necesitará el personal (p. ej., software o suministros) para llevar a cabo el proceso

Estos campos garantizarán que todo el mundo tenga la información necesaria para seguir el documento con facilidad.

CONSEJO DE PROPINA:

Con el fin de animar a los empleados a que utilicen la plantilla para documentar sus propios procesos, plantéate crear un programa de recompensas para incentivar la participación. Es probable que la documentación no encaje en la idea que tiene el equipo de pasarlo bien, pero la motivación para hacerlo será mucho mayor si, por haber documentado 15 procesos para final del mes, les invitas a comer pizza o les das media jornada libre el último viernes del mes.

3. Decide dónde almacenar los procesos

Recuerda: la documentación debe ser accesible si quieres que se utilice. Si todavía no lo has hecho, crea una carpeta o un espacio donde poder alojar todos estos registros.

Lo ideal es que también se puedan hacer búsquedas cómodamente en todo lo que uses, de forma que la gente no tenga que indagar a fondo para dar con lo que necesita.

4. Reserva tiempo para hacer limpieza

Incluso cuando se implanta un proceso de documentación sofisticado, las cosas se complicarán de vez en cuando. Habrá documentos que acaben en el lugar equivocado o pasos que tendrán que actualizarse.

Reserva un poco de tiempo cada mes o cada trimestre para revisar toda la documentación y hacer un poco de limpieza, tanto si eso implica ajustar los procesos u organizar los archivos. De este modo, contribuirás a que el sistema se conserve en perfecto estado y que, por consiguiente, aumenten las probabilidades de que la gente lo use.

Consulta esta guía para indagar en los detalles esenciales sobre la forma de crear un proceso para tu documentación interna.

Cómo puede ayudarte un software de documentación interna

Tu equipo puede ser de gran ayuda a la hora de organizar la documentación interna, pero la tecnología también puede intervenir para facilitarte el trabajo. Es mejor optar por un programa informático de documentación interna que por un sistema de archivos alojado en ordenadores sueltos. De este modo, posibilitarás que el personal contribuya fluidamente, ya que el programa te brinda la capacidad de editar páginas de forma conjunta, de recopilar comentarios mediante comentarios integrados y en las páginas, y de etiquetar a otros miembros del equipo para que hagan sus aportaciones.

El programa también te permite crear un centro de conocimientos organizado en el que las páginas relacionadas estén agrupadas en un espacio exclusivo y con funciones de búsqueda avanzada. El resultado es un recurso organizado en el que todo el equipo puede confiar.

¿A qué sería de gran ayuda? Eso pensamos nosotros. Echa un vistazo a Confluence para empezar a crear documentación interna que garantice la homogeneidad y reduzca el estrés.

Ahórrale a tu equipo dolores de cabeza y molestias

Resulta tentador tildar a la documentación interna de formalismo innecesario. No obstante, piénsatelo bien: ¿qué pasaría si tu empleado estrella te presentara hoy mismo su carta de dimisión? ¿Cuál sería la cantidad de conocimientos y experiencia valiosos que perderías?

Al implantar unas prácticas de documentación eficaces, garantizarás que tanto tu equipo como tú estéis listos para afrontar esas circunstancias imprevistas con una sensación de optimismo y confianza.

Puede que también te interese

Plantilla de artículo de instrucciones

Proporcionar una guía paso a paso para completar una tarea

Plantillas de Confluence

Crea cualquier cosa en Confluence: desde los requisitos de los productos hasta los planes de marketing

A continuación
Process documentation