Comenzar a usar la documentación

Documentar es tan fácil como explicar una receta a otra persona. Lo simple o complicado que sea, depende las herramientas que uses y lo familiarizado que estés con ellas. Si quieres grabar un vídeo y no sabes usar una videocámara o teléfono, puede ser un poco enredado. De igual forma, si quieres documentar en línea, pero no conoces el software, puedes enredarte innecesariamente. 

Por eso hemos creado esta guía para que conozcas los conceptos básicos e instrucciones esenciales para documentar en línea usando el software Bookstack.

Bookstack es una biblioteca digital

Bookstack usa la idea biblioteca para organizar la documentación, por lo que cada tema se documenta en libros, que pueden contener capítulos y páginas con texto, imágenes, etc. Y a su vez, estos libros pueden organizarse dentro de estantes. Esta idea hace muy fácil su uso y ayuda a mantener la documentación ordenada.

Supongamos que quisiéramos documentar recetas de comida, nuestra documentación podría organizarse de la siguiente forma en Bookstack:

• Estante: Recetas familiares
  • 📘 Libro: Recetas de la Abuela María
    • Capítulo: Postres
    • Capítulo: Atoles
  • 📘 Libro: Recetas de la Familia Caal 
    • Capítulo: Recados tradicionales
    • Capítulo: Tamales
• Estante: Recetas del mundo
  • 📘 Libro: Recetas de México
  • 📘 Libro: Recetas de El Salvador

Muy simple de entender, ¿cierto?

Documentar es un ejercicio de creatividad

Toda documentación surge de una página en blanco. Es algo que queremos contar, pero a veces no sabemos que forma darle, por lo que toma tiempo y esfuerzo. No te frustres si no consigues documentar tan rápido como quisieras, pero asegúrate de avanzar poco a poco. Por eso decimos que es un ejercicio de creatividad, porque debes ejercitarte para poder hacerlo cada vez mejor.

La mejor forma de comenzar a documentar es imaginar que estás explicándole algo a otra persona, o a ti misma, pero unos dos años en el futuro:

• ¿Qué necesita saber para hacer eso que quieres explicarle?
• ¿Cómo puedes explicárselo con palabras que le sean familiares?
• ¿Cómo puedo explicárselo de forma interesante para que no se aburra?
• En dos años, cuando regrese a realizar este procedimiento, ¿Qué sería importante recordar? 

También es un ejercicio de colaboración

Uno de los objetivos más importantes de la documentación es compartir información. Es expresar algo que nosotros sabemos, pero que necesitamos que otras personas sepan.

Documentar es hacer visible nuestro conocimiento para que otros aprendan, y a su vez nos ayuden a realizar nuestro trabajo. Es un ejercicio permanente de colaboración. Siempre tendrás conocimientos nuevos que compartir y aprender, y cuanto más compartas, más aprenderás. 

Así que no pienses en la documentación como algo estático y aburrido, sino como algo dinámico que tú y otras personas harán crecer, y que mientras lo hacen podrán compartir, y todo eso es un buen ejercicio de colaboración.

Y un ejercicio de respeto

Como todo trabajo colaborativo, debe comenzar con la creación de acuerdos para trabajar, de lineamientos básicos, de calidad y altas dosis de empatía, de pensar en los demás y como los demás.

Es válido pensar que otras personas desconocen alguna las cosas que estás documentando, precisamente para eso las estás documentando, pero no asumas que no saben nada o que saben menos, porque posiblemente saben muchas otras cosas que tú desconoces, así que muestra respeto al compartir información y dar indicaciones.

La mejor forma de documentar es hacerlo en función de las necesidades de los demás. Pregúntales qué necesitan saber y de qué forma les sirve más, e intenta satisfacer esas necesidades. De esa forma, tu esfuerzo será más eficiente y tendrá un mayor impacto. 

¡Comencemos!