Consejos para mejorar tu documentación técnica

La documentación es una herramienta fundamental en el día a día los departamentos de IT. Elaborar guías adaptadas a las necesidades concretas de cada equipo es clave a la hora de compartir información y experiencia. Una características común a estos documentos de uso interno son las diferencias en el estilo y el formato con el que se presenta la información. Este artículo muestra consejos sencillos para mejorar esta documentación.

Una buena parte de las guías de referencia que se generan en los departamentos de IT encuentran en formato Word o PDF. Word sigue siendo el programa de edición más común dentro y fuera del mundo de la empresa. Pero resulta llamativo que, a pesar de las opciones incorporadas a este software a lo largo de los años, la forma en la que lo usamos hoy no es muy distinta de la de hace 20 años. Parece razonable preguntarse, ¿es esta la mejor opción?

Antes de aventurarnos en la redacción del documento, pensemos por un momento en la mejor forma de hacer llegar el contenido a nuestra audiencia. Si tenemos en cuenta que las guías técnicas elaboradas por equipos de IT son normalmente de uso interno, parece tener sentido trabajar en algún medio web al que los usuarios puedan acceder fácilmente y en el que sea posible realizar comentarios de forma sencilla, como una wiki o el propio Google Docs. Estos medios permiten incorporar el ciclo de revisión dentro del propio ciclo de vida del documento, es decir, no hay un tiempo delimitado para revisar el documento o publicar una nueva versión ya que el contenido está siempre actualizado y siempre disponible para su revisión.

He extraído este listado de recomendaciones basándome en un documento interno que se me pidió revisar. Casi todos los ejemplos utilizados están tomados de la documentación técnica de Microsoft en MSDN.

Escribe con un lenguaje sencillo y directo

Al escribir un documento técnico debemos acercarnos al punto de vista del lector, utilizando siempre un tono directo y empático. El uso de palabras y expresiones sencillas debe ir acompañado del uso del término adecuados en todo el texto. Cuando empleamos términos distintos para referirnos a una misma cosa, el lector no familiarizado con la materia puede asumir que en realidad estamos hablando de cosas distintas. Evitemos también usar jerga o acrónimos que no son de uso común.

Usa la voz activa siempre que sea posible

Adoptar la voz activa nos acerca al usuario del documento y simplifica la comprensión del texto. En este caso es el usuario -o el objeto de la acción- y no la acción, quien adopta el papel activo. Veamos dos ejemplos de uso de la voz pasiva y su correspondiente cambio a voz activa:

Voz pasiva:

The backup process can be canceled at any time. / El proceso de copia de seguridad puede ser cancelado en cualquier momento.

The encryption mechanism is provided by the background secproc.d daemon. / El mecanismo de encriptación es realizado en segundo plano por el demonio secproc.d.

Voz activa:

You can cancel the backup process at any time. / Puedes cancelar el proceso de copia de seguridad en cualquier momento.

The secproc.d background daemon provides the encryption mechanism. / El demonio  secproc.d realiza en segundo plano el mecanismo de encriptación.

Utiliza la forma presente del verbo

Usar de la forma presente del verbo facilita la comprensión del texto y proporciona al lector seguridad sobre sus acciones. Veamos un ejemplo usando la forma futura:

To continue, click Install. SQL Server Setup will first install the required prerequisites. / Para continuar, haz clic en Instalar. El Instalador de SQL Server instalará primero los prerrequisitos necesarios.

y el mismo ejemplo con la forma presente:

To continue, click Install. SQL Server Setup installs the required prerequisites first. / Para continuar, haz clic en Instalar. El Instalador de SQL Server instala primero los prerrequisitos necesarios.

Elimina las palabras innecesarias

Como ya he comentado, una de nuestras prioridades es acercar el documento al lector, mediante un lenguaje sencillo y evitando construcciones complejas. Por ejemplo, la siguiente expresión:

In order to complete the backup process select Finish. / Con el fin de completar el proceso de copia de seguridad, selecciona Finalizar.

la podemos simplificar fácilmente:

To complete the backup process, select Finish. / Para completar el proceso de copia de seguridad, selecciona Finalizar.

Otro ejemplo es el uso de palabras innecesarias como recommended (recomendado) o please (por favor):

It is recommended to use a high-performance drive for the database journal. / Es recomendable usar un disco de alto rendimiento para el journal de la base de datos.

Como autores del documento, se da por sentado que lo allí escrito es nuestra recomendación. Podemos simplificar esta expresión diciendo:

Use a high-performance drive for the database journal. / Utiliza un disco de alto rendimiento para el journal de la base de datos.

En el caso de please, se emplea generalmente para rebajar -digámoslo así- el carácter imperativo del uso de la voz activa. Siempre que el tono y voz general del documento sea sencillo y directo, no debemos preocuparnos por esta cuestión.

Usa las imágenes de forma correcta

Una de las razones por las que el uso de las imágenes es escaso en la documentación técnica profesional es que su gestión es compleja. Si además estas imágenes tienen que mostrarse en diferentes idiomas, el problema se multiplica. Antes de incluir una nueva imagen, debemos plantearnos si hacerlo aporta valor a aquello que queremos describir. Estas son algunas pautas al tratar imágenes:

Incorpora imágenes para aclarar el funcionamiento de interfaces

Esta situación se da en interfaces de usuario pobremente diseñadas, donde el flujo de acciones que ha de seguir el usuario para completar la tarea no está claro. En estos casos conviene añadir imágenes resaltando los elementos de la interfaz necesarios para completar la tarea. Una imagen bien empleada puede simplificar enormemente el flujo de trabajo del lector.

Añade un borde estándar para las capturas de pantalla

Cuando tengamos que pegar capturas de pantalla en un texto, es conveniente añadir un borde a la imagen. De esta forma evitamos el fondo de la imagen se confunda con el fondo del documento, provocando una separación desigual de los elementos en pantalla:

Ajusta el tamaño de la imagen a la acción que estamos describiendo

Debemos evitar usar capturas de pantalla que incluyen un area demasiado grande o demasiado pequeña. Si el paso que estamos redactando describe un cuadro de diálogo concreto en la interfaz de usuario, carece de sentido incluir una captura de pantalla de todo el escritorio.

Divide tareas complejas en subtareas

Las tareas con un gran número de pasos son más difíciles de seguir y entender. Pensemos que si el lector ha de fijar su atención en una tarea que tiene 32 pasos, es fácil que pierda la atención en algún momento, con el riesgo añadido de dejar atrás algún paso esencial dentro del proceso. No siempre es posible describir una tarea con un número reducido de pasos, pero siempre podemos dividirla en subtareas.

Usa listas y flujos para resumir procesos complejos

La instalación y configuración de ciertos paquetes de software puede llegar a ser enormemente compleja. Normalmente esto sucede cuando el flujo de acciones no es único, o cuando se llevan a cabo varias acciones en paralelo. En todos estos casos es casi imprescindible acompañar el texto con un diagrama de flujo (workflow) que permita entender la tarea en su conjunto. Estos diagramas no son fáciles de realizar, pero el tiempo invertido en ellos aporta un gran valor al documento.

En otros casos, el lector está muy familiarizado con en el proceso que se va a realizar, pero necesita una guía de referencia rápida. Es lo que comúnmente llamamos una lista de comprobación o checklist. Al trabajar con estas listas, lo más común es añadirlas o enlazarlas al final del documento como un anexo.

Describe una acción completa en cada paso

Cada paso en un proceso define una acción completa del usuario. Veamos un ejemplo:

4. In the right pane of the Database Engine Tuning Advisor GUI, type MySession in Session name.

5. Select File for your Workload, and click the Browse for a workload file button to locate the MyScript.sql file that you saved in Step 1.

El paso 5 en esta tarea incluye varias acciones (select, click, locate) pero todas ellas forman parte de una misma acción completa (cargar un fichero en el programa).

Si es necesario realizar alguna aclaración sobre una acción, es mejor hacerlo dentro del paso correspondiente de la tarea, y no como un nuevo paso. El siguiente ejemplo ilustra la forma correcta de añadir esta información:

10. On the Feature Selection page, select the components for your installation.

SQL Server Setup will install the prerequisite that are not already installed during the installation step described later in this procedure.

11. On the Server Configuration — Service Accounts page, specify login accounts for SQL Server services.

En el siguiente ejemplo el uso no sería correcto, ya que el paso 2 no es realmente un paso en la tarea, sino una aclaración sobre el paso anterior:

1. Click the import configuration button.
2. The Configuration import dialog appears.

3. Wait until the end of the process.

Establece un formato único para elementos comunes

Usar un estilo unificado para los elementos de la interfaz mejora el aspecto visual del documento y facilita su lectura. Habitualmente queremos destacar tres elementos al describir un proceso:

  • Nombres de ficheros o carpetas.
  • Elementos de la interfaz de usuario (botones, menús, etc.).
  • Ejecución de sentencias o comandos.

Debemos definir un único estilo para esto tres elementos y ser constantes en su uso a lo largo del documento. Este sería un ejemplo que podemos tomar como punto de partida:

Elemento: Nombres de ficheros o carpetas
Estilo: Letra cursiva. Ejemplo: Double click the setup.exe file.

Elemento: Componentes de la interfaz de usuario.
Estilo: Letra negrita. Ejemplo: Click Run and then click OK.

Elemento: Código, sentencias o comandos.
Estilo: Letra de ancho fijo. Ejemplo: Type <setup.exe /a> to start the setup process

A pesar de la extensión y profundidad común a todas las guías de estilo, la mejora más inmediata y apreciable se consigue con la aplicación de un conjunto de normas sencillas. Recordar y practicar estas normas no es complejo, y el beneficio a corto y largo plazo será considerable.