¿Cuánto humor es efectivo en la documentación técnica?

Es bien sabido que a los presentadores en vivo a menudo se les recomienda agregar una dosis de humor para atraer mejor a la audiencia.

Sin embargo, muy rara vez veo humor en la documentación técnica escrita; esto a pesar de que también es ampliamente conocido que la mayoría de las personas rara vez se involucran con la documentación y la consumen de manera muy ineficaz cuando lo hacen.

"The Feynman Lectures on Physics" son un buen ejemplo de la inclusión del humor. ¿Evitar el humor es solo una tradición cultural, o hay investigaciones que indican que no hay un impulso de compromiso al usarlo en la documentación escrita? (O, como espero, ¿hay investigaciones que indiquen tal impulso)?

Cuando el reactor está en llamas, las bon mots del autor del manual son menos placenteras que cuando te quitaste la chaqueta porque la habitación parecía un poco calurosa.
Incluya un enlace a su referencia. Y posiblemente una cita.

Respuestas (6)

El usuario típico de la comunicación técnica tiene prisa y está de mal humor. Estaban trabajando tratando de hacer un trabajo para poder ir a casa y cenar con los niños, luego algo se rompió o se negó a funcionar como pensaban que debería hacerlo, o una pieza no funcionaba correctamente, o apareció un error de en ninguna parte, o todo el sistema dejaba de funcionar y empezaba a salir humo azul.

No están de humor para bromas.

Deberíamos pensar en la comunicación técnica como una parada en boxes. Es el momento de brindarle al usuario lo que necesita para continuar de la manera más eficiente y con el menor drama posible. No hay tiempo en una parada en boxes para hablar del dentista y la hija del granjero.

Por eso no hay humor en la mayoría de las comunicaciones técnicas y por eso no debería haberlo.

El humor en los materiales de aprendizaje es otra cuestión. A algunos les gusta. Algunos lo desprecian. Si está vendiendo un libro de Dummies, puede atraer solo a aquellos a quienes les gusta y dejar que las personas que no compran un libro de O'Reilly. Pero si esta es su capacitación corporativa, probablemente no quiera apagar a la mitad de su audiencia.

¿Qué pasa con la documentación de uso interno solamente?
@tuskiomi Internamente, a menudo será lo mismo. El usuario todavía tiene prisa y está de mal humor por las mismas razones. Pero internamente no existe la misma motivación para agregar cosas para hacer que la documentación sea atractiva como la que existe con los usuarios externos. Hacerlo gracioso no sirve para ningún propósito comercial interno.

El Manual de estilo de Microsoft lo expresa bien:

No intentes ser gracioso. Las bromas, la jerga y el sarcasmo son específicos del contexto y difíciles de traducir y localizar. Lo que es divertido para ti puede ofender o alienar a una parte de tu audiencia, por lo que es mejor evitar estos enfoques retóricos.

Los libros de Dummies son una excepción a la regla, pero las personas que los compran son una audiencia autoseleccionada.

De acuerdo en que la localización es una gran preocupación. Ya es bastante difícil evitar el uso accidental de lenguaje idiomático, ¿por qué esforzarse por agregar más contenido intraducible?

El humor implica una intimidad y una informalidad que normalmente no son apropiadas para las comunicaciones técnicas. Ya sea que se trate de una solución de error tensa o de una situación en la que algo se me estropeó como describe Mark Baker , un documento instructivo que se usa en un entorno comercial o profesional, o cualquier otra cosa, en la mayoría de los casos es impropio presumir un nivel particular de familiaridad. con un lector.

Además: ¿y si creen que la broma es terrible? (O peor: ¿ofensivo?) Es mucho más probable que pierda la buena voluntad de un lector al que no le gusta el humor, que ganar mucha buena voluntad de un lector al que le gusta.

La mayoría de las veces, el humor se interpone en el camino.

La regla general en la comunicación tecnológica es evitar el humor, y creo que los principales puntos a considerar son: audiencia, contexto y localización, si es que estás considerando esto.

Hablando específicamente sobre la preocupación por la localización, la traducción del lenguaje idiomático es una consideración importante, pero otra preocupación importante son las interpretaciones culturales de tu humor.

Vi una presentación interesante en LavaCon el año pasado donde Jon Ann Lindsey, estratega de contenido de Google, habló sobre sus propios intentos e investigaciones sobre esto.

En resumen: Google alienta a su personal a ser "Googly" e hicieron un gran estudio de caso en el que grupos de enfoque de unos 40 países diferentes miraron su documentación y de hecho hicieron que alguien se sentara con estos grupos en persona para recibir comentarios. Descubrieron que incluso las referencias humorísticas más pequeñas (por ejemplo, una imagen de un lindo pingüino de su biblioteca de imágenes que se usó en su documentación) se encontraron mal en muchas regiones. Parte de esto era desconocimiento porque es posible que las personas de algunos países nunca hayan visto un pingüino. Otros encontraron simplemente exasperante e inapropiado que alguien intentara insertar "humor" o "ternura" donde intentaban obtener información técnica.

Mi principal conclusión de esto fue: conoce a tu audiencia. Si está localizando contenido, esto es aún más difícil e imperativo. Desafortunadamente, muchos de nosotros no tenemos los mismos recursos que tiene Google para realizar este tipo de investigación a escala global, por lo que probablemente sea mejor permanecer en el ámbito de lo básico.

Para mejorar su investigación sobre pingüinos, los usuarios que son empleados de Microsoft deberían haber sido excluidos de la muestra :P

depende de la audiencia

Personalmente, siento que la escritura técnica es demasiado seca. Sin embargo, como ingeniero, he hecho mucho. Siempre trato de agregar humor y ligereza para hacerlo más agradable. Esto ha tenido resultados variables.

Aquí hay un ejemplo en el que me excedí en la ligereza y fue bien recibido. Para un informe de física, mi compañero y yo decidimos usar el diccionario de sinónimos en cada palabra que pudimos sin cambiar el significado, reemplazando las palabras comunes con su sinónimo más oscuro y enrevesado. El informe es el balbuceo más ridículo y exagerado que he escrito, pero es técnicamente correcto. Recibimos la máxima puntuación y un tirón de orejas por 'mejilla'.

En otra ocasión, cuando escribía el informe de mi proyecto de fin de año, estaba trabajando en la sección 'por qué este proyecto'. El proyecto se trataba de un sistema de aterrizaje guiado por visión para drones autónomos y pensamos que sería apropiado poner la razón principal como 'los drones son geniales'. Esto no fue bien recibido, perdimos puntos por ser 'poco profesionales'.

Desafortunadamente, todavía tengo que entender cómo diferenciar la primera audiencia de la segunda. A veces los lectores lo apreciarán ya veces te crucificarán por ello. Depende de usted juzgar a su audiencia y si puede salirse con la suya. Si crees que no te meterás en problemas, hazlo. El mundo de la escritura técnica podría usar un poco más de ligereza.

Me gusta esta respuesta. Pero, ¿qué quiere decir con "usar el diccionario de sinónimos en palabras iguales que podríamos..." Supongo que debería decir cada. ¿Pero quieres decir que usaste sinónimos? Sería genial si pudiera proporcionar un enlace.
@SybillePeters Gracias por detectar el error tipográfico. Desafortunadamente todavía no tengo una copia de ese informe. Fue hace muchos años y varios ordenadores. Básicamente, reemplazamos cada palabra normal con el sinónimo más largo y poco común que pudimos.

Recientemente tuve que supervisar la introducción de un sistema de TI personalizado en un entorno industrial. Algunos chistes internos en el manual funcionaron bastante bien durante el entrenamiento. Estaban en la línea de usar el nombre de una persona analfabeta informática conocida para ilustrar el inicio de sesión o enumerar pedidos de ejemplo que son imposibles de llevar a cabo por razones no obvias.

Sin embargo, en este ejemplo, 1) el humor era completamente tangencial al mensaje técnico, no se gastaron palabras en él, 2) fue sutil hasta el punto de la negación, 3) fue específico para la audiencia, permitiéndoles sentirse inteligentes por conseguir las referencias.

En tales circunstancias, he visto funcionar un humor tan sutil. De lo contrario, no hay espacio en la documentación técnica para ello. Es mejor proporcionar brevedad. En mi experiencia, el problema con la redacción técnica no es la falta de humor, sino el exceso de formalidades repetitivas y la voz pasiva.