Microsoft marca el camino a seguir en documentación técnica

El nuevo servicio documental de Microsoft es mucho más que un cambio estético en la plataforma de contenidos.

La pasada semana, Microsoft dio a conocer su nueva plataforma documental docs.microsoft.com. Este cambio, detallado en la primera entrada del blog del equipo, incluye elementos que no resultan novedosos en sí mismos, pero que sí lo son cuando se trasladan al ámbito de la documentación técnica. El aspecto de la documentación es ahora más parecido al de un blog que al del clásico documento técnico, con artículos más cortos y la incorporación de elementos como el tiempo de lectura de cada artículo, tipografías de mayor tamaño y diversas herramientas de comentario que recuerdan instantáneamente a Medium.


Las nuevas opciones de comentario y petición de cambios se añaden al clásico cuadro de sugerencias al final de cada artículo (que se mantiene). Con todas estas opciones y la posibilidad de añadir notas a cada párrafo no queda claro, sin embargo, qué respuesta pueden esperar los usuarios y cómo se integrarán las sugerencias enviadas en el documento final.

Pero la novedad más relevante no es estética. La gestión de cambios se realiza ahora desde GitHub, lo que permite solicitar revisiones del documento fuente mediante peticiones pull en la plataforma. Y todo ello aprovechando la sencillez de Markdown, lenguaje cuyo uso se está popularizando en los últimos años. Este uso de la plataforma GitHub no es nuevo -de hecho, Microsoft lo utilizaba ya en otras partes de su documentación-, pero por su generalización y la importancia de Microsoft, marca un punto de inflexión y un camino a seguir por otros fabricantes.

Jeff Sandquist, autor del artículo, señala también que los cambios incorporados no son sólo estéticos o de funcionalidad, sino también de contenido. Aunque no es mucho más lo que se dice sobre este aspecto, el comentario parece indicar que la documentación estará más orientada a la realización de tareas, algo que se puede ver ya en los artículos técnicos de Azure.

Aquellos que, de una u otra forma, trabajamos con la documentación del fabricante, hemos visto cómo se sucedían pequeños cambios en los últimos años, pero sin ninguna transformación significativa. Microsoft acomete así una transición necesaria, después de un tiempo en los que sus tres grandes áreas documentales -TechNet, MSDN y más recientemente, Azure- parecían evolucionar por caminos distintos.

El contenido de la nueva plataforma es aún escaso, pero los cambios introducidos apuntan a una documentación más adaptada a las necesidades del usuario, mejor estructurada y posiblemente con menos errores, gracias a las nuevas herramientas de comentario.


(este artículo fue publicado originalmente en LinkedIn el 11-05-2016)

Escribe historias, no interfaces

Resulta curioso observar cómo, mientras las aplicaciones para la web y dispositivos móviles tienden a simplificar la interfaz de usuario con el paso del tiempo, las aplicaciones para escritorio parecen seguir un camino opuesto. La solución adoptada para añadir nuevas funcionalidades a un programa sigue siendo, en muchos casos, incorporar más elementos a la interfaz, generalmente sin la adecuada planificación y en detrimento de la usabilidad. La documentación del producto puede suplir esta deficiencia si los escritores técnicos entendemos que nuestra función es la de describir tareas -contar historias- y no interfaces.

Hace unos días necesitaba revisar la información de un documento de trabajo bastante extenso. Al no disponer de mucho tiempo, pensé que la mejor opción sería imprimir el documento en formato libro para poder leerlo en el camino de regreso a casa sin desperdiciar mucho papel -con documentos largos, resulta incómodo hacer esto en la pantalla del móvil. En el momento de imprimir el documento me encontré con el siguiente cuadro de impresión que, con pocas variaciones, será familiar para muchos de los que trabajamos en una oficina:


Me considero un usuario de ordenadores avanzado, pero reconozco que me costó un par de impresiones fallidas encontrar la combinación de opciones para conseguir el formato deseado -dando al traste con mis buenas intenciones de ahorrar papel y ayudar al medio ambiente. El caso particular del software de impresión es paradigmático porque, después de décadas de desarrollo, su uso sigue siendo complejo y, en muchos casos, encontrar la opción adecuada continúa siendo una cuestión de prueba y error.

En el año 2000, Steve Krug publicó su famoso Don’t Make Me Think (del inglés, No Me Hagas Pensar) introduciendo un concepto por entonces desconocidos para la inmensa mayoría: la usabilidad. El libro fue un éxito casi inmediato y, con el paso del tiempo, se ha convertido en un clásico. Es mucho lo que se ha avanzado en este sentido desde entonces, especialmente en el diseño de páginas web y, más recientemente, de aplicaciones para dispositivos móviles. Pero a pesar de todos estos avances, el uso de las aplicaciones que instalamos en nuestros equipos sigue siendo poco intuitivo. Pensemos por un momento en los paquetes de ofimática o de diseño gráfico que encontramos y usamos habitualmente, y que incorporan un conjunto de opciones tan grande como intimidante. Esta complejidad dista mucho de la facilidad de uso a la que las aplicaciones para móviles nos han acostumbrado. Parecería que, mientras que las aplicaciones diseñadas para dispositivos móviles o para la web han llevado a cabo una necesaria simplificación, aquellas instaladas en nuestros ordenadores han seguido el camino opuesto.

Es justo reconocer que mantener la sencillez y facilidad de uso de un programa resulta complejo. La evolución del software, por su propia función, es entrópica. Incluso programas que comienzan con un número limitado de opciones de configuración, suelen acabar en un conglomerado de menús y botones al cabo de pocas versiones. Mantener la usabilidad y simplicidad resulta difícil porque la tendencia natural del software es la de incorporar un número creciente de opciones. La solución en estos casos pasa hoy por arrojar -normalmente sin demasiado acierto- más elementos a la interfaz, lo que se traduce en un uso cada vez más complejo para el usuario.

Hay dos razones fundamentales que explican este hecho. Por un lado, el fabricante del software entiende que la evolución de su producto tiene que venir por la incorporación de nuevas funcionalidades y opciones. La demanda de los usuarios y la competencia de otros productos dejan pocas alternativas. Incorporar estos cambios manteniendo la usabilidad requiere un gran esfuerzo por estudiar, en una fase temprana, cómo interaccionan los usuarios con el software, y encontrar soluciones imaginativas a los problemas detectados. Un ejemplo clásico de este tipo de soluciones lo tenemos en la aparición del Ribbon (o Cinta) en Microsoft Office, un elemento de la interfaz que redujo la complejidad de un número creciente de opciones y menús, permitiendo que el usuario pudiera trabajar con estos programas sin sentirse abrumado. Otro ejemplo más reciente lo tenemos en Google que, tomando como base su iniciativa de simplificación de interfaces denominada Material Design (del inglés, Diseño Material), ha adoptado una solución visualmente atractiva -y efectiva- para mostrar al usuario sus opciones de configuración de cuenta.


Por otro lado, mantener la usabilidad de una interfaz requiere una decisión valiente y arriesgada por parte del fabricante. Valiente porque limitar el número de opciones visibles -en lugar de incorporar otras nuevas- supone adoptar decisiones en nombre del usuario. Y arriesgada porque la simplificación puede dejar fuera a aquellos usuarios que esperan cada vez más funcionalidades del producto. Un ejemplo de esto lo encontramos en Apple que, de forma premeditada, oculta opciones avanzadas de configuración en su sistema operativo de escritorio OS X, con el objetivo de simplificar el trabajo de los usuarios menos avanzados. Aunque menos visible en las últimas versiones de su sistema operativo, la facilidad de uso ha sido siempre una característica de la marca (característica que el escritor Ken Segall, autor del libro Increíblemente Simple, considera la clave del éxito de Apple).

Pero, ¿en qué modo afecta todo esto a la documentación de un producto? Cuando una interfaz es compleja, nuestra obligación como escritores técnicos es ofrecer una interfaz mejor, que cuente al usuario aquella historia que el software no puede contar. La documentación ha de ser la nueva interfaz entre el usuario y aquel programa que se resiste a la simplificación. Las guías de usuario no pueden seguir siendo una descripción aséptica de opciones, menús y botones sin relación aparente, han de ser el relato que encaje con la tarea que el usuario se dispone a realizar. Debemos abandonar la idea de describir interfaces y comenzar a escribir tareas o, si preferimos llamarlo así, historias.

Hacer una descripción de todos los elementos y controles en pantalla puede ser de gran utilidad para el usuario avanzado, pero obliga al menos experimentado -precisamente el más común- a intentar descifrar qué opciones llevan a conseguir el resultado esperado. En el manual de la impresora de mi oficina, al que se podía acceder directamente desde el botón Help (Ayuda) de la ventana de impresión, se avanza un poco en este objetivo de describir tareas, añadiendo algunas acciones comunes de impresión en Métodos de impresión de uso frecuente -mi opción de impresión en formato libro parece no ser frecuente. Sin embargo, la escasa información de este apartado contrasta con la explicación detallada de cada uno de los controles de la interfaz en el apartado Ajustes que se pueden cambiar en cada menú.

El software debe aspirar a ser fácil e intuitivo. Pero trasladar la simplicidad de una aplicación móvil a una de escritorio es, en la práctica, complejo. Los fabricantes pueden y deben invertir más en usabilidad ya desde la fase de concepción del producto -y no como un elemento más a añadir tras el desarrollo. Donde esto no suceda así, la documentación debe ser capaz de rellenar ese hueco.

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.