3 Herramientas para empezar a Documentar procesos técnicos

Cuando trabajaba como Soporte Técnico siempre teníamos la problemática que el conocimiento o la experiencia solo la podías adquirir si te sentabas al lado de un empleado Senior y veías cómo trabajaba él o ella. Tenías que poner atención sobre cómo eran sus prácticas, cómo respondía llamadas o e-mails, pero además tenías que memorizarte todo.

Casi en todos mis empleos anteriores era lo mismo: pasar una semana (o un mes) en una aula, donde un Trainer al frente te explicaba cómo funcionaba la empresa y después tenías que pasar largas y tediosas horas frente a una computadora de la empresa aprendiendo cómo funcionaba la plataforma o el servicio que iba a otorgar.

Capacitar/Entrenar/Enseñar a las personas siempre ha sido un reto para las industrias en México. Estamos acostumbrados a la tradicional manera de enseñar donde una persona repite el patrón de un salón de clases. Y al final se evalúa con un examen… pero si tienes suerte, tal vez exista una biblioteca disponible en la que puedes consultar lo que aprendiste, o confiarte de tus propias notas.

Existen distintas técnicas y herramientas en las que una Empresa, un Mánager o un Supervisor pueden crear una librería de procesos que facilitarán las actividades diarias.

En la Industria se le conoce como Knowledge Base o Troubleshooting Guides.

Cuáles son los beneficios de tener un Knowledge Base?

•Aumenta la productividad
• Mejora la imagen corporativa frente a empleados y clientes
• Mejora la marca de la empresa y se gana reputación como una empresa confiable
• Atrae y retiene los mejores empleados, ya que tienen la información necesaria para realizar sus tareas
• Optimiza procesos y resultados.

Un Knowledge Base (KB) es un conjunto de documentos y guías que resuelven 5 de las principales dudas que tiene un empleado de cualquier industria cuando experimenta un problema en sus actividades:

  • ¿Cómo puedo identificar el tipo de problema?
  • ¿Cómo han resuelto mis compañeros en ocasiones anteriores un problema similar?
  • ¿Cuáles son los síntomas o comportamientos del problema?
  • ¿Qué pasos debo seguir para resolverlo?
  • ¿Cuál es el resultado que debo de tener?

Es prácticamente tener la información disponible para solucionar un problema técnico.

Un Knowledge Base puede evolucionar y crecer tanto hasta hacerse un Knowledge Management System…pero eso lo hablaremos en otra ocasión.

¿Cómo puedo entonces empezar a crear un KB con pocos recursos?

Existen otras opciones de paga como Confluence, Foros y otros que son en Cloud, pero dejaremos esas opciones para otra ocasión ya que nos centraremos en soluciones para quienes están empezando a documentar.

En esta ocasión, nombraré 3 herramientas, algunas son gratuitas y otras de costo accesible:

1 OpenKM

Es una chulada por que en primera, la versión más pequeña es gratis (Versión Community) y es compatible con Windows y Linux.

Esta herramienta que te ofrece distintas versiones (Professional, Cloud y Community) es de las más User-Friendly pues es fácil de implementar y de configurar, te permite administrar las distintas versiones y tener previews de los documentos.

2 Drupal

Si, Drupal. Puedes customizar y armar tu propio sistema de Knowledge Base Articles como si fueran entradas de artículos.

Puedes armarlo con distintos módulos, los que te recomiendo son: Views, Taxonomy y asegúrate de instalar un editor de texto WYSWYG. (En otra entrada explicaremos cómo instalar módulos en Drupal).

Primero comienza por definir qué categorías usarás para separar el tipo de problemas, por ejemplo: Equipment Issues, Software Installation, Script Errors. Te sugiero crear las categorías basadas en las situaciones más comunes.

Después crea entradas tipo Articles, y sigue el siguiente formato sugerido:

[Título del issue]
[Etiquetas o Categorías]
[Descripción del Problema]
[Screenshots]
[Pasos para resolver el problema]
[Jira tickets relacionados con el problema o ID del Reporte]

Un Ejemplo de cómo utiliza una compañía en la vida real un Knowledge Base Article con Drupal lo puedes encontrar en esta url.

Usando Drupal tendrás la libertad de modificar y adaptar tu Knowledge Base a tu manera y tenerlos disponible en línea para tus usuarios.

3 Google Drive

No es muy práctico, pero es útil para empezar a documentar. En Google Drive por medio de carpetas y documentos es posible crear una librería de documentación y KB articles.

Empieza por crear un Documento de texto y a hacer una guía básica siguiendo la estructura mencionada arriba. Asígnale estilo, colores y formato básico.

En el ejemplo anterior se describen procesos de una herramienta ficticia llamada “MilaMilla”.

Dependiendo de los permisos que tengas y el tipo de licencia Google Drive que tengas, es posible crear documentos basados en una plantilla, de esta manera no tendrás que escribir todo el formato de nuevo y sólo tendrás que reemplazar valores. La empresa debe tener una G Suite account para que puedas implementarlo de manera masiva.

Una vez creado tu documento y después de haberle dado el formato deseado (imagen, tipo y tamaño de letra, etc.) en una pestaña nueva de tu navegador, deberás ir a la siguiente URL: drive.google.com/templates. En esta página podrás subir tus templates, mismos que se compartirán con toda tu organización.

Conclusiones:

El formato o la estructura que le asignes a tus KB son tu elección, lo importante, es que el conocimiento quede documentado para que tus empleados puedan resolver problemas sin afectar su productividad.

No importa qué herramienta uses, lo importante es documentar y compartir el conocimiento.