Obsidian: alternativa para almacenar y generar Documentación Técnica.

Cuando hacemos nuestras investigaciones, estudiamos un nuevo lenguaje o herramienta o nos piden hacer un informe sobre un suceso, necesitamos generar documentación técnica.

A lo largo del tiempo he ido utilizando desde herramientas sencillas como Typora hasta verdaderas navajas suizas como CherryTree.

Hace un par de años conocí Joplin y quedé encantado con su simplicidad, con su forma de sincronizar contra distintos servicios. Es la herramienta que he estado usando hasta ahora para recoger esa información técnica y además para apuntar mis notas.

Permite organizar las notas en libretas y generar sublibretas dentro de estas, visualizando la información de forma jerárquica. Dentro de las libretas y sublibretas se pondrán las notas o tareas de tipo ToDo.

Todas estas herramientas tienen algo en común. Soportan que se tomen las notas en formato md, MarkDown.

MarkDown es un lenguaje sencillo de aprender que se utilizar para generar documentación técnica. Es sencillo formatear un documento y exportarlo a PDF para la lectura de personas menos técnicas.

Este fin de semana que ha sido un poco largo por las festividades de Semana Santa, he <<descubierto >> Obsidian, es una aplicación pensada para apuntar todas aquellas anotaciones técnicas que necesitemos.

Organiza las notas en directorios y ficheros físicos de nuestro disco. A todo ese conjunto lo define como Bóveda.

Nada más arrancar la aplicación nos pide o abrir una bóveda o crearla.

Para crearla necesitamos darle un nombre y una ubicación en nuestro sistema de ficheros.

Para escribir la entrada en el blog, he definido la siguiente estructura de directorios/ficheros simulando una recopilación de información de una web:

Donde TestWeb es el nombre de la bóveda, 00 Reconocimiento pasivo y 01 Reconocimiento activo son directorios y recon-ng un subdirectorio en el que he incluido un fichero llamado host con el siguiente contenido en MarkDown

El mismo contenido haciendo previsualización:

Y el mismo contenido exportado a PDF:

Lo interesante es que al organizar el árbol de forma jerárquica, va creando los directorios/ficheros en la unidad elegida para almacenar la bóveda. De esta manera todo lo que hayamos creado en la aplicación, lo podemos visualizarlo y navegar en el sistema de ficheros.

Como podemos ver es una muy buena alternativa para recopilar la información de algún trabajo que estemos haciendo, sea este de una investigación, un curso que estemos realizando, configuraciones de algún servidor/sistema o para lo que podamos hallarle utilidad.

Podemos ampliar sus capacidades mediante plugins oficiales o de la comunidad.

Lo probaré durante las siguientes semanas a ver si me hago a esta nueva forma de trabajo y dejaré Joplin únicamente como gestor de notas.

He visto que se puede configurar la apariencia y colores al exportar a PDF pero eso lo dejo para otra entrada.

Saludos =)

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *