Manuales de software: de los libros técnicos a los tutoriales en YouTube

Manual de ZDUMP
Los manuales técnicos han recorrido mucho camino desde su nacimiento al día de hoy. De ser para unos pocos, hemos pasado a una base de aprendizaje mucho más democratizada gracias a los videotutoriales

Para realizar cualquier tarea es necesario que antes se nos explique primero qué tenemos que hacer. Por poner un ejemplo rápido: puedes coger una escoba para barrer unas migas de pan del suelo, pero si nadie te indica cómo se usa esta herramienta vas a tener que invertir un tiempo en descubrirlo tú mismo. De acuerdo, nos estamos refiriendo a algo muy sencillo. Pero, ¿qué pasa cuando se trata de ejecutar tareas complicadas o de conocer la sintaxis de un lenguaje de programación? Ahí es donde entran en juego los manuales técnicos y de procedimientos, que han pasado por un tremendo proceso de evolución.

En un principio los manuales técnicos eran grandes volúmenes en papel de precio muy elevado que no estaban al alcance de todos los bolsillos. Hoy en día se pueden encontrar manuales de todo tipo publicados en toda clase de formatos a lo largo y ancho de Internet. Actualmente cualquiera con un navegador web y tiempo que invertir en Google puede conocer los secretos de, por ejemplo, el lenguaje PHP si está dispuesto a buscar cómo.

Otra forma muy popular de adquirir conocimientos tecnológicos a día de hoy es a través de videotutoriales. Con la llegada de plataformas como YouTube y el establecimiento de la era digital, es cada vez más común intentar conseguir la información que necesitamos en un momento concreto de la forma más inmediata posible. Y es que ¿para qué vamos a leer un documento de mil páginas cuando podemos recibir la información que necesitamos, para lo que necesitamos y en pocos minutos?

Manual de MS-DOSManual de MS-DOS / Ash Kyd editada con licencia CC 2.0

Escritura técnica, la base de todos los manuales

Antes de entrar en materia sobre la historia de los manuales técnicos, deberíamos aclarar que para elaborarlos se utiliza un método conocido como escritura técnica. Una definición formal de este método podría ser la de todo texto escrito con la finalidad de transmitir todo tipo de conocimientos en distintos campos técnicos, como son información sobre hardware, software, ingeniería, química, aeronáutica, robótica, finanzas, electrónica de consumo y biotecnología.

Además, según la Society for Technical Communication estadounidense, la escritura técnica tiene que incluir al menos una de estas tres características para poder ser considerada como tal:

  • Comunicar acerca de temas técnicos o especializados como aplicaciones informáticas, procedimientos médicos o regulaciones medioambientales.
  • Comunicar a través de la tecnología, ya sean páginas web, archivos de ayuda o redes sociales.
  • Ofrecer instrucciones acerca de cómo hacer algo, sin importar la naturaleza técnica de la tarea.

La escritura técnica la lleva a cabo la figura del escritor técnico. Un escritor técnico es un escritor profesional que produce documentación técnica. Dicha documentación ayuda a las personas a comprender mejor el uso de un producto o servicio y puede incluir ayuda online, manuales, especificaciones de diseño, planes de proyecto, planes de pruebas y etcétera.

Actualmente los escritores técnicos también crean documentación online para sistemas de e-learning, que en los últimos años ha experimentado un auge muy destacado.

Manual de los procesadores Motorla DSP 56800Manual de los procesadores Motorla DSP 56800 / JD Hancock editada con licencia CC 2.0

Así surgieron los manuales técnicos

La escritura técnica lleva siendo reconocida como una profesión desde la Segunda Guerra Mundial, pero sus raíces se pueden rastrear hasta la antigüedad. De hecho, en la web del departamento de Ciencias del Deporte de la Universidad Federal de Río de Janeiro, se dice que hacia el año 4.500 a.C. los sumerios elaboraron tablillas de arcilla que contenían todos los conocimientos de la época para el aprendizaje de un círculo social dominante.

Sin embargo, los trabajos de Aristóteles son considerados como las primeras muestras de escritura técnica. No sería hasta la invención de la imprenta, la llegada del Renacimiento y el auge de la Era de la Razón que se tendría la necesidad de documentar todo lo que se descubriese y cómo se había conseguido. Isaac Newton y Leonardo Da Vinci prepararon documentos que llevaban un registro detallado de sus inventos y sus hallazgos, que después jugaron un papel crucial en el desarrollo de formas modernas de comunicación y escritura técnica.

Durante la Revolución Industrial creció la necesidad de instruir a los trabajadores en el uso de las máquinas, cada vez más y más complejas. A diferencia de tiempos pasados, donde los conocimientos se pasaban de una persona a otra, sólo los inventores de los artilugios sabían cómo funcionaban. Por tanto, escribir documentación sobre cómo funcionaba un aparato era la forma más fácil y efectiva de transmitir ese conocimiento.

Antigua máquina industrial a vaporAntigua máquina industrial a vapor

Durante el siglo XX la necesidad de manuales técnicos aumentó de forma espectacular. La profesión del escritor técnico se reconoció oficialmente. Por otro lado, los eventos de la Primera Guerra Mundial y la Segunda Guerra Mundial propiciaron avances en medicina, equipamiento militar, tecnología computacional y aeroespacial. Este rápido crecimiento, junto con la urgencia de la guerra, creó una necesidad inmediata de documentos bien diseñados y elaborados que explicasen punto por punto cómo funcionaban todas estas tecnologías.

Una vez terminada la guerra entre los Aliados y el Eje, los avances tecnológicos llevaron a un aumento de la tecnología de consumo y del nivel de vida, lo que también hizo que hubiese que desarrollar más documentación para explicar el funcionamiento de estos aparatos.

En los años más recientes el aumento del uso de los ordenadores como una herramienta generalizada dentro de la sociedad ha llevado a muchos avances en el campo de las comunicaciones. Esto ha provocado cambios en las herramientas usadas para producir documentación técnica: hipertexto, procesadores de texto, programas de edición de gráficos y de maquetación de páginas han hecho que la creación de documentos técnicos sea más facil que nunca, lo que ha obligado a los escritores técnicos a tener experiencia con estos programas.

Los editores de texto son fundamentales para elaborar documentaciónLos editores de texto son fundamentales para elaborar documentación

Cronología de la escritura técnica

Según podemos leer en ProEdit, el primer documento técnico moderno “oficial” data de 1949, cuando Joseph D. Chapline escribió el manual de uso del computador BINAC. De esta forma, Chapline se convirtió en el primer escritor técnico en documentar el uso de un ordenador. Este mismo escritor escribiría el manual de UNIVAC en 1952, esta vez usando ejemplos que acompañaban a las instrucciones técnicas.

A partir de 1960 el crecimiento continuo de la tecnología —especialmente de la electrónica, la aeronáutica y la industria aeroespacial— aumentaría la demanda de escritores especializados. En esta década, concretamente en 1964, Marshall McLuhan publicaría Understanding Media, proclamando que la comunicación electrónica transformaría al mundo en una “aldea global”.

En 1965 Ted Nelson acuñó los términos “hipertexto” e “hipermedios” para describir un modelo de escritura y acceso a la información no secuencial, destacando la importancia de las conexiones entre ideas. Diez años más tarde, el gobierno de Estados Unidos requeriría que todas las garantías de los productos se redactasen de forma clara y no ambigua.

Edición de hipertexto en 1969Edición de hipertexto en 1969 / Wikimedia Commons editada con licencia CC 2.0

En 1976 la Modern Language Association aprobó un panel sobre escritura técnica en su conferencia anual, mientras que en 1980 la escritura técnica conseguiría amparo legal como profesión legítima.

Hacia 1986 el ANSI estadounidense publicaría el Standard Generalized Markup Language o SGML, que más adelante serviría como fundación de otros lenguajes de marcas como HTML. Un año más tarde empezarían a aparecer los primeros programas informáticos que ayudarían a los escritores técnicos a elaborar sus documentos. Algunos de ellos son Ventura Publisher, Interleaf, FrameMaker y Aldus PageMaker.

Con la llegada del nuevo milenio se generaliza el uso de XML entre los escritores técnicos.

HTML también es una herramienta de escritura técnicaHTML también es una herramienta de escritura técnica

Algunos tipos de manuales técnicos que vemos a diario

Podemos definir un manual técnico como aquel que va dirigido a un público especializado con instrucciones sobre cómo realizar un tipo determinado de tarea. Es importante documentar cualquier tipo de proyecto —especialmente los relacionados con tecnología— para identificar más fácilmente los aspectos y características que forman parte de él.

Como usuarios consultamos manuales técnicos con más frecuencia de la que pensamos. A continuación repasamos algunos de los más frecuentes con los que nos enfrentamos —o nos hemos enfrentado— de forma recurrente.

Manuales de referencia de lenguajes de programación

Manual de referencia de PHP5Manual de referencia de PHP5

Un manual de referencia de un lenguaje de programación describe un lenguaje de forma que usuarios y programadores puedan entender sus elementos básicos y empezar a escribir código de programación tomándolo como base lo más pronto posible.

Este tipo de manual es una forma de documentación que se asocia con los principales lenguajes de programación. Un manual de referencia o referencia técnica es el justo opuesto de una especificación, que suele ser mucho más detallada y dirigida al uso de quienes implementaron un lenguaje en sí. Por norma general, las especificaciones nunca llegan a quienes únicamente buscan realizar una tarea.

Guías de usuario de programas informáticos, básicas para empezar

Guía de usuario de Google EarthGuía de usuario de Google Earth

Los manuales o guías de usuario son, grosso modo, libros que explican el funcionamiento de aplicaciones informáticas. Hoy en día han evolucionado hasta llegar a Internet, de donde podemos destacar la Guía de usuario de Google Earth como ejemplo. En estos manuales online podemos encontrar enlaces entre distintos apartados.

En cualquier caso, el término “guía” en un manual de usuario se refiere a un documento que trata un aspecto específico del software. Estos aspectos pueden ir desde la instalación del mismo, pasando por cómo empezar a usarlo y varios apartados destinados a mostrar cómo realizar ciertas tareas.

En algunas aplicaciones de software corporativo se limita el acceso a sólo una parte de la funcionalidad del programa a un grupo determinado de usuarios. En estos casos, el grupo en cuestión recibirá sólo la parte de la documentación de la funcionalidad que puede utilizar.

Páginas de manual de Unix, lo que necesitas saber está ahí

Página de manual del comando lsPágina de manual del comando ls

Una página de manual de Unix es una forma de documentación del software accesible a través de la terminal que se puede encontrar en estos sistemas o en sus derivados, como sería el caso de GNU/Linux. Los temas que estas páginas cubren van desde programas de ordenador, pasando por estándares formales y convenciones e incluso conceptos abstractos.

Para usar estas páginas de manual es necesario usar este comando:

man <nombre_del_comando_que_se_consulta>

Por ejemplo, para saber qué podemos hacer con el comando ls tendríamos que usar esta instrucción:

man ls

Durante los dos primeros años de existencia de Unix no existía documentación alguna. Hasta 1971 no se publicaría el Unix Programmer’s Manual, escrito por Dennis Ritchie y Ken Thompson con la asistencia de Doug McIlroy.

El manual de Unix cubre varios aspectos básicos:

  • Comandos.
  • Llamadas de sistema.
  • Funciones de las librerías.
  • Formatos de archivo.
  • Juegos y miscelánea.
  • Arranque y proceso de login.

Estas páginas de manual se revisan frecuentemente.

Manuales de videojuegos, una especie en extinción

Assassin's Creed con su manual de usuarioAssassin's Creed con su manual de usuario / Michel Ngilen editada con licencia CC 2.0

Los videojuegos suelen o solían tener grandes manuales debido a que algunos como los juegos de estrategia o los simuladores requieren explicaciones detalladas de su funcionamiento. En los tiempos en los que Steam era aún un brillo en el ojo de Gabe Newell hasta se incluían instrucciones de instalación en los títulos para PC. Debido a que algunos de estos documentos podían ser tan extensos y aparatosos, en muchas ocasiones se podía encontrar una tarjeta de referencia detallando algunos pocos aspectos básicos.

En la era arcaica de los juegos de ordenador incluso existían los listados de claves dentro del manual, que servían como protección contra la copia.

Otros manuales iban mucho más allá de ser simples guías. Algunos juegos basados en hechos históricos requerían explicaciones detalladas, así como los que tenían tramas muy complejas.

Del manual al tutorial, del tutorial al videotutorial

Tutorial publicado por nosotros para instalar Bash en WindowsTutorial publicado por nosotros para instalar Bash en Windows

Ya hemos comentado que, en el momento de su aparición, los manuales eran voluminosos, caros y no estaban al alcance de todo el mundo. También hemos visto que, con la aparición de Internet, su publicación online ha hecho que puedan llegar a mayores audiencias que ya no tienen que desembolsar una fortuna para comprender como funciona un servicio o programa concreto. También, gracias a Internet, hemos sido testigos de la aparición del videotutorial.

Antes de entrar en la definición de lo que es un videotutorial, convendría aclarar primero qué es un tutorial. Para quienes no estén familiarizados con el término, un tutorial es un neologismo de origen inglés que suele utilizarse en el ámbito de la informática. Se trata de un curso breve y de escasa profundidad, que enseña los fundamentos principales para poder utilizar algún tipo de producto o sistema, o para poder realizar una cierta tarea.

Un videotutorial vendría a ser lo mismo, pero con una explicación mucho más gráfica en la que el usuario puede seguir el proceso paso a paso y ver qué debe hacer con sus propios ojos de forma exacta, sin tener que interpretar o deducir las instrucciones que se leen en un papel o en una pantalla de ordenador.

La existencia de YouTube ha hecho de los videotutoriales algo enormemente popular. La red de vídeos online está llena de ejemplos de todo tipo de estos contenidos. Su temática puede ser muy variada: desde cómo gestionar carpetas en Windows, pasando por la instalación y desinstalación de programas en Linux hasta asuntos que no tienen nada que ver con la informática como, por ejemplo, qué hacer para crear una base rítmica de hip hop.

Características de un videotutorial

El auge del multimedia ha propiciado la aparición de herramientas de apoyo en la educación muy poderosas. Dado que los videotutoriales son lecciones o cursos breves y con poca profundidad, se pueden tratar aspectos mucho más específicos de forma mucho más inmediata y facilitar mejor su comprensión por quienes los siguen.

Dicho de otra manera, una de las características de los videotutoriales es que son tremendamente directos. Es decir, si buscamos la forma de, por ejemplo, gestionar y cambiar la contraseña de la red WiFi, a través de este medio se nos dirá cómo hacerlo y qué herramientas utilizar. Un videotutorial no nos explicará cómo funciona el software utilizado para ello en profundidad, sino que se limitará a explicarnos el proceso y nada más.

Quedándonos con esta característica, vale la pena mencionar que son mucho más inmediatos que un manual. Volviendo al ejemplo de cambiar la contraseña de la red WiFi, con buscar un videotutorial que explique cómo hacerlo será suficiente y nos llevará pocos segundos. De otra manera tendríamos que buscar el manual de usuario del router, buscar la información que necesitamos, leerla, interpretarla y ponerla en práctica.

Como ya hemos comentado, son la forma más gráfica de aprendizaje que podemos encontrar en Internet. Podremos seguir el proceso paso a paso si seguimos la explicación que se nos da, que nos llevará a conseguir resultados similares a los que hayamos visto. Después queda en manos del usuario seguir explorando y jugando con las distintas posibilidades que el software le ofrezca.

Los videotutoriales han democratizado mucho el proceso de aprendizaje técnico. Si bien no entran en aspectos detallados sobre cómo funciona el software que se utiliza a la hora de realizar una determinada tarea, han logrado que prácticamente cualquiera pueda aprender a hacer cualquier cosa —aunque sea de forma somera y sin profundizar—.

Richard Masoner editada con licencia CC BY-SA 2.0

Relacionados

Nos encanta escucharte ¿Nos dejas tu opinión?