Cursos comunicación técnica
/

Programa de cursos otoño 2019

El verano se antoja caliente, ¡pero el otoño está que arde! Talleres sobre la guía de redacción y cursos de Adobe FrameMaker en Euskadi y Navarra en todo tipo de fechas y lugares:

¡Nos vemos!

Jornadas Comunicación Técnica Euskadi 2018
/

Primer año del taller «Produce tus manuales con orden y concierto»

¡Estamos de celebración ?! El taller «Produce tus manuales con orden y concierto» ha cumplido un año y ha sido todo un éxito. 8 ediciones por todo Euskadi, casi 100 participantes y otras dos ediciones programadas para septiembre. ¡Y que siga así!

Gracias a la iniciativa de enpresa digitala de la SPRI hemos podido acercar los principos de una buena guía de redacción (o guía de estilos) a los comunicadores técnicos geográficamente más cercanos a ISTEN. Y todo ello para contenidos de productos físicos o para contenidos de software.

Comunicación técnica modularizada y estandarizada
Con la guía de redacción:
productos seguros, procesos de gestión de información fluidos y contenidos útiles

Espero que este sea el inicio de algo mayor, una semilla para que la formación en Comunicación Técnica se vaya asentando y termine por germinar… Estamos muy rezagados y hay mucho que recuperar frente a países como Alemania (líder europea en el sector), pero también respecto a otros países que han logrado organizarse y contar con una oferta formativa estable (pienso en Dinamarca, Francia, Italia, etc.).

Curiosamente, el pasado viernes, en el taller realizado en BIC Araba en Miñano, la sala en la que dimos el taller fue la misma en la que estaba ubicada la empresa con la que empecé mi andadura como redactor técnico hace más de 20 años… Mucho ha llovido desde entonces y poco se ha avanzado. ?

Taller en BIC Araba (Miñano)
Último taller del curso en BIC-Araba: ¡Mi antigua oficina!

Sirva también esta entrada para el siguiente anuncio: si alguien tiene una idea de cómo cambiar esta tendencia, ¡seré todo oídos a propuestas! ??

Si te interesa este campo de la Comunicación Técnica, en nuestros próximos cursos podrás saber algo más sobre el tema.
Actualmente tenemos abiertas convocatorias para el taller sobre el diseño de la guía de redacción al que te puedes apuntar en la web de enpresa digitala. ¡Anímate!

Sam Tarly. I read the books and followed the instructions
/

Lee libros y sigue sus instrucciones

Y no lo digo yo: lo dice Sam Tarly, personaje clave en Juego de Tronos. Sí, yo también he caído al fin y estoy siguiendo la serie. Hay de todo, especialmente intriga y oscuridad, pero también hay razón y luz. Y mucha luz sale de lo que recogen los libros.

En mi opinión, la primera ley de la Comunicación Técnica es que «nadie se lee el manual» (versión minimalista-exagerada). Todos queremos probar enseguida el producto y no nos apetece leer antes de actuar (por múltiples razones). No obstante, hay muchas situaciones en las que sí necesitamos acceder al manual, y es ahí donde se la juega un producto.

Y en Juego de Tronos lo tienen claro: Samwell Tarly tiene éxito porque busca y sabe encontrar «oro» en los libros y porque sigue las instrucciones que los maestres dejan para la posteridad. ?

Documentación embebida en un neumático
/

Documentación embebida ¿en un neumático?

No, no se trata de una pantalla insertada en un neumático con ayuda contextualizada ?. Es algo más sencillo. Hace unos días me encontré con el siguiente ejemplo curioso de documentación embebida:

Documentación embebida en un neumático

Así es, neumáticos con instrucciones de seguridad. Son algo díficiles de leer, pero ahí están. Es un ejemplo más de cómo los comunicadores técnicos estamos en todas partes y de que tenemos que colaborar con todo tipo de personas en una organización. También con las personas que diseñan el producto.

Comentario final (pequeña crítica al contenido): El formato del aviso de seguridad no se corresponde con lo que dicta la norma ISO 82079. Ya sé que no es información de un documento (está sobre el propio producto), pero estoy bastante seguro de que al menos la palabra-señal «Warning» no aplica. Y no hablemos del idioma: ¿Saben leer en inglés TODOS los técnicos de taller? Hmm…

Pregunta a mis lectores: ¿tenéis por ahí otros ejemplos de documentación embebida?

Conformidad legal. Con la seguridad no se juega
/

Conformidad legal: con la seguridad no se juega

¿Tu producto tiene riesgos residuales con peligros para la salud de las personas? Entonces tu empresa (sea fabricante o representante) está obligada por ley a una instrucción para el manejo seguro del producto a lo largo de todo su ciclo de vida.

¿Qué puede pasar si tus contenidos no son conformes con esa legalidad?

  • Inspectores de marcado CE (seguridad de producto) pueden multar a tu empresa con hasta 100.000 € [sin ningún accidente de por medio].
  • Una vez haya accidentes, la administración puede imponer multas de hasta 85 millones € por responsabilidad de producto.
  • Y si en ese caso de accidente, te atacan por la responsabilidad civil, la compensación no tiene límites…

¿He conseguido despertar tu interés? Si has llegado hasta aquí, entiendo que algo sí… Ahora te preguntarás: ¿Cómo puedo hacer que mis contenidos cumplan? Bien, todo esto se puede resumir en dos puntos (si me lo permiten los superexpertos en la materia):

  • Trazabilidad con análisis de riesgos residuales.
  • Estructura y formulación de la información de seguridad

Trazabilidad con evaluación de riesgos residuales

¿De dónde sacan los redactores la información de seguridad? ¿Intuición? ¿Experiencia? ¿Espíritus de la Comunicación Técnica? En muchos manuales, es el caso. Sí, ese es el caso y muchos de los redactores técnicos del mundo confirmarán esta cuestión (idea: publicar una encuesta al respecto).

La información de seguridad que debe aparecer en la documentación técnica tiene que ser resultado de un trabajo estructurado. Durante el diseño del producto, el fabricante está obligado a realizar una evaluación y reducción iterativa del riesgo. Los entregables de este trabajo son

  • Un diseño con el riesgo mínimo
  • La definición de medidas de protección externas
  • La información de seguridad que deriva de riesgos residuales del producto en todo su ciclo de vida.

Y es esta información de seguridad la que podemos utilizar los redactores forma ordenada y trazable en nuestra documentación. Ni intuición, ni experiencia, ni espíritus: Nuestros compañeros de diseño y desarrollo con orden y concierto.

Evaluación de riesgo, "performance levels" y tipos de avisos de seguridad
Categorización de avisos de seguridad según valoración de riesgos:
párametros de riesgo (*; ver final blog), «performance levels» y tipos de avisos de seguridad

Estructura y formulación de la información de seguridad

Pero no solo tenemos que asegurar el «qué» (contenidos derivados de la evaluación de riesgos), también el «cómo»: la estructura y el formato de información de seguridad para dos tipos de contenidos.

  • El capítulo de seguridad de las publicaciones técnicas.
  • Los avisos de seguridad en las instrucciones.

Algunas cuestiones a dominar por un redactor técnico: Títulos de los avisos, fuente y tipo del riesgo, medidas de evasión, colores, pictogramas (ojo: no se recomienda usar pictogramas)… Mucha salsa para una entrada en un blog.

Conclusión

Si la documentación no tiene información de seguridad trazable con una evaluación de riesgos y/o no se ajusta a la estructura y el formato que dictan las normas, situamos a nuestro producto fuera del marco legal y cerca del riesgo empresarial.

Más información: ISO IEC 82079, ANSI Z535.6 e ISO 12100:2011-03.

Si te interesa este campo de la Comunicación Técnica, en nuestros próximos cursos podrás saber algo más sobre el tema.
Actualmente tenemos abiertas convocatorias para el taller sobre el diseño de la guía de redacción al que te puedes apuntar en la web de enpresa digitala. ¡Anímate!

Refuerzo

(*) Parámetros de riesgo, según ISO 13849-1

[ver imagen superior]

S: Gravedad de la lesión     

  • S1= lesiones menores (normalmente reversibles)     
  • S2= lesiones graves, incluida la muerte (normalmente irreversibles)

F= frecuencia o duración de la exposición al peligro     

  • F1= poco frecuente a más frecuente o durante períodos breves     
  • F2= muy frecuentemente a continuamente o durante períodos prolongados

P: posibilidades de evitar el peligro     

  • P1= posible en ciertas condiciones     
  • P2= muy poco posible
La era Reiwa está al caer
, /

El poder de la palabra en Japón

En una conversación de ayer con un amigo empresario del sector de Comunicación Técnica de largo recorrido en España y con contrastada experiencia internacional, me volvía a recordar: «Pablo, en España no hay interés por la comunicación de calidad. Esa es la razón por la que no ha funcionado el asociacionismo en Comunicación Técnica. Predicas en el desierto.»

Y mi sensación de estar en el desierto se agudiza cuando comparo con otras dos culturas que conozco y con las que estoy todos los días en contacto (la alemana y la japonesa). Entonces me doy cuenta del reto al que me enfrento.

Ayer mismo, para rematar las palabras de mi amigo, llegó una noticia desde Japón: ya le han puesto nombre a la nueva era que comienza el 1 de Mayo, la era «Reiwa» (令和). Si dar un nombre a un recién nacido japonés es toda una ceremonia, darle el nombre a una era ha sido todo un espectáculo. Japón se paró ayer por completo, con discusiones sobre los diferentes significados de la palabra (tanto la versión oficial como las alternativas). Es admirable cómo casi cada japonés es un filólogo o terminólogo en potencia. Y todo eso se consigue con duro trabajo en la infancia (de eso soy también testigo).

Reacciones ayer en Japón (actualizado)

Yo me resisto a que el diagnóstico de mi amigo sea tan pesimista, pero tengo que reconocer que hay mucha verdad detrás (hay que ser realista). No obstante, seguiré insistiendo, llamando a todas las puertas posibles para que la formación estructurada en Comunicación Técnica en España sea una realidad. Espero poder aportar algo de esa pasión japonesa por la comunicación y por su medio de transporte, las palabras. 頑張りましょう!(que se traduce como «¡Ánimo, vamos a por ello [con esfuerzo]!»).

Si te interesa nuestro informe sobre Comunicación Técnica en España, suscríbete aquí a nuestro boletín y ¡podrás llevártelo como regalo de bienvenida!

Visualización, ilustraciones, animaciones
/

Visualización, gráficos y animaciones: por qué y para qué

Visualización en Comunicación Técnica, todo un arte y una necesidad. ¿Por qué? Pues sí, porque sólo con palabras no es posible. ¿Para qué? Las funciones y objetivos de la visualización son muchos: estructurar contenidos, identificar ubicaciones, explicar procesos y funcionalidades, motivar la lectura, generar anclajes en la memoria…

En mi mente, el mundo de la visualización lo divido en tres partes:

  • Diseño de contenedores de información: el layout visual de la información. Qué formato tienen nuestras páginas (en papel o electrónicas, estáticas o interactivas) y cómo se presentan los textos y los elementos gráficos.
  • Elementros gráficos estáticos: aquí diferencio yo entre fotografías (imágenes reales) e ilustraciones (gráficos elaborados por humanos). En el apartado de ilustraciones podemos segmentar mucho: ilustraciones de dibujo técnico (CAD), ilustraciones a línea en blanco-negro o con colores, ilustraciones 2D o 3D (incluyendo aquí también VR y AR), etc…
  • Elementos gráficos animados: también hago una diferenciación entre contenidos realistas (los llamo vídeos) y elaborados (animaciones).

La temática da para mucho, por lo que dejaré sólo unos esbozos de los tres temas en los apartados siguientes.

Diseño visual de productos de información

En el siguiente ejemplo podemos ver la página de un manual con un diseño visual «quasi» inexistente:

Documento sin diseño visual

El usuario identifica visualmente una serie de títulos y párrafos, pero no hay más elementos que le guíen por el contenido. Y dentro de los párrafos podemos encontrarnos con texto del siguiente tipo:

El selector A debe colocarse en posición 1. La lámpara de control verde se enciende. Preste atención que no se encuentren fluidos en el depósito. La bomba está preparada para la operación. Puede iniciar con la aspiración. 

Contenido extraído de un manual de una bomba de aspiración, capítulo «Operación».

¿Infumable, verdad?

A continuación un ejemplo de mejora visual y textual. El primer paso es clasificar y ordenar funcionalmente los segmentos de este texto (por ejemplo, siguiendo la metodología Funktionsdesign ®). Segundo paso: aplicar algo de formato a los elementos funcionales del texto, Paso final: mejorar su redacción («lo pide a gritos»; tema: redacción profesional y comprensibilidad).

Mejorar un texto con Funktionsdesign
Ejemplo de mejora visual y textual conFunktionsdesign ®

Y esta instrucción puede mejorar más visualmente incluyendo por ejemplo ilustraciones para identificar ubicaciones y formas de trabajo.

Fotografías e ilustraciones

Una imagen vale más que mil palabras. Todos de acuerdo, especialmente si eres fan de Lego (toda una referencia en instrucciones visuales), pero también hasta un límite. ¿Quién no ha sufrido algo con las instrucciones de IKEA (especialmente hace 10-15 años)?

Por un lado comentemos el mundo de la fotografía. Con fotografías logramos dar información realista, pero hacer fotos requiere de formación. Si la foto no está realizada con profesionalidad puede ocultar información (por ejemplo por sombras reflejos) o incluir información que distrae al usuario (fondos de fotografía distraen).

Fotografías versus ilustraciones técnicas.
Fotografía b/n con sombras y fondo molesto vs ilustración técnica con detalles claros

Las ilustraciones técnicas son la mejor solución para la Comunicación Técnica gráfica: los profesionales del sector las producen con relativa facilidad, especialmente si contamos con información 3D de partida. Además de la capacidad de centrar mejor nuestra atención, cuentan con la ventaja de poder ser fácilmente reutilizables (gestión de versiones y variantes de contenidos).

Vídeos y animaciones

YouTube ha revolucionado nuestras vidas. Procesos complejos explicados con imágenes en movimiento son más «sexy» y requieren mucho menos esfuerzo que leer instrucciones paso a paso.

Para los vídeos hay un mundo propio, también en la Comunicación Técnica. Un ejemplo son los «utility films». Está de moda explicar todo con vídeos, pero hacerlo bien es igual que la fotografía: requiere de metodología. Ah, y un recordatorio (pensando en los aficionados a buscar en vídeos con remedios caseros):

⚠ ATENCIÓN
Riesgo de no conformidad legal. Aplicable a productos con riesgos residuales para las personas.

No sustituya con vídeos o animaciones la documentación escrita vinculada al manejo seguro.

Las animaciones pueden ser más baratas de realizar que un vídeo si queremos llegar al mismo nivel de calidad. Y al igual que con las ilustraciones, podemos reutilizarlas mejor. En el siguiente ejemplo podemos imaginarnos lo que cuesta explicar todo este proceso con palabras y elementos gráficos estáticos.

Otros ejemplo de animación esta vez del sector de la biomedicina (sí, no toda la CT es industrial o software…): como mejora una instrucción estática con un trabajo de animación. Nótese como el cambio de estilo de tener fotografías a trabajar con infografías animadas nos ayuda a centrarnos más en el contenido y menos en detalles realistas de las fotos.

Antes (formato estático, fotografía):

Instruccion respirador con fotografías.

Después (animación, infografía):

Ahora bien, elaborar ilustraciones de calidad es algo relativamente costoso: Antes de entrar en este mundo es importante identificar qué tipo de componentes gráficos necesitamos, cuándo aplica cada tipo y si hay presupuesto para la cantidad y calidad que pretendemos publicar (tema: estrategia de contenidos).

¿Curiosidad por la visualización?

Si te interesa este campo de la Comunicación Técnica, en nuestros próximos cursos podrás saber algo más sobre el tema.
Actualmente tenemos abiertas convocatorias para el taller sobre el diseño de la guía de redacción al que te puedes apuntar en la web de enpresa digitala. ¡Anímate!

Agradecimiento

¡Gracias a Paco González de Infographics por las ilustraciones!

Calidad de contenidos, utilidad, comprensibilidad
/

Calidad con contenidos útiles

¿Qué debo hacer para que mis contenidos técnicos sean útiles? ¿Es posible medir la calidad de mis publicaciones técnicas? Preguntas razonables cuando queremos evaluar nuestra Comunicación Técnica.

La comprensibilidad, clave para la utilidad

Un contenido es útil cuando el usuario lo acepta como contenido comprensible. El estudio sobre la comprensibilidad ya viene de antiguo (ver por ejemplo la retórica clásica y también las seis reglas de escritura de George Orwell), pero en los últimos tiempos ha experimentado un importante desarrollo desde diferentes puntos de vista.

Las conclusiones de qué es un contenido comprensible pueden llevar por ejemplo a que un texto tenga las siguientes características:

  • Fácil de entender.
  • Breve y exacto (conciso).
  • Fácil de memorizar.
  • Legible sistemáticamente.
  • Accesible a través de diferentes formas de lectura (leyendo de principio a fin, localizando referencias, buscando errores, etc.).
  • Bien estructurado.
  • Fácil para búsquedas.

El truco: conocer a tu usuario

Pero habrás observado que en la lista anterior está escondido un peligro: ¿comprensible para quién? No todos los textos están preparados para todas las audiencias: un análisis de los usuarios de los contenidos que sea lo más detallado posible es fundamental. Sólo teniendo bien claro los grupos de usuarios podremos desarrollar los productos de información en sus tres partes principales:

  • Elección del mejor soporte de publicación
  • Diseño visual (cuidando los aspectos culturales asociados)
  • Definición de los diferentes niveles de estructura de los contenidos (desde su meta- y macroestructura con el concepto de navegación, pasando por la estructura de componentes/fragmentos y hasta la microestructura de frases y términos).
Sin un análisis de usuarios no es posible crear contenidos comprensibles.

Cómo medir la comprensibilidad

¿Es posible medir la comprensibilidad como indicador principal de calidad de los contenidos? Aunque se trate de un concepto algo volátil, es posible aplicar tres tipos de aproximaciones a los test de comprensibilidad (ref.: Schriver, 1989):

  • Análisis de el texto: métodos enfocados en el texto y su correlación con características de (presumible) comprensibilidad.
  • Métodos enfocados en la evaluación por expertos: valoración de comprensibilidad por parte de profesionales lingüísticos.
  • Tests de usabilidad enfocados en el lector: evaluación de cómo responden los lectores a los textos, con qué facilidad pueden seguir las instrucciones o aprender cosas de un texto.
Medir la comprensibilidad

Analiza tus textos

Si bien los métodos enfocados en el texto pueden ser comparativamente baratos, éstos pueden llevar a resultados erróneos. Entre otros aspectos estos métodos no evaluan la visualización del contenido, que es parte fundamental para la comprensibilidad. No obstante, actualmente hay una explosión de posibilidades tecnológicas en este campo con la aparición de asistentes de redacción asequibles. Hay aplicaciones genéricas como Yoast para WordPress [que es lo que utilizo para este blog], y programas especializados y configurables con memorias de redacción (que ayudan a reutilizar y reducir costes a nivel de frase), control de calidad lingüístico (por ejemplo, con fórmulas de legibilidad) y con herramientas de control terminológico (control a nivel de palabra).

Consulta a expertos

Preguntar a expertos puede ser una buena idea, pero ellos deben estar siempre alineados con los usuarios finales del texto.

Si puedes, haz tests de usabilidad

Pero de los tres métodos, el enfocado en el lector es sin duda la mejor solución (si puedes permitírtelo…): aquí nos encontramos con métodos y herramientas que hoy en día se estudian bajo el término de «usabilidad» o experiencia de usuario. En la «User Experience» hay muchos expertos, valga la redundancia, que seguro pueden ayudarnos a los comunicadores técnicos a la hora de enfrentarnos a tests de usabilidad de contenidos técnicos.

Por ejemplo, es muy interesante el estudio de la comprensibilidad en el diseño de pictogramas. Una regla fundamental en la Comunicación Técnica es recordar que los pictogramas son siempre interpretables. Buscando un poco en internet me he encontrado con un estudio de metodologías de diseño de pictogramas (Duarte, M. E. C.; Rosa, C.; Rebelo, F.; Duarte, C. 2009). En él hacen uso del «Comprehensibility Judgment Test (ISO 9186, 2001)» para evaluar con usuarios los diseños. Es curioso sólo un diseño logra más del 75% de comprensión…

Diseño de pictogramas y resultados de test de comprensibilidad

¿Interesado en comprensibilidad?

Si te interesa este campo de la Comunicación Técnica, en nuestros próximos cursos podrás saber algo más sobre el tema.
Actualmente tenemos abiertas convocatorias para el taller sobre el diseño de la guía de redacción al que te puedes apuntar en la web de enpresa digitala. ¡Anímate!

Referencias

Orwell, George (1946). “Politics and the English Language”

1. Never use a metaphor, simile, or other figure of speech which you are used to seeing in print. 1) Nunca uses una metáfora, símil u otra figura retórica que estés acostumbrado a ver por escrito.
2. Never use a long word where ashort one will do. 2) Nunca uses una palabra larga donde puedas usar una corta.
3. If it is possible to cut a word out, always cut it out. 3) Si tienes la posibilidad de eliminar una palabra, elimínala siempre.
4. Never use the passive where you can use the active. 4) Nunca uses una voz pasiva cuando puedas usar la activa.
5. Never use a foreign phrase, a scientific word, or a jargon word if you can think of an everyday English equivalent. 5) Nunca uses una locución extranjera, una palabra científica o un término de jerga si puedes encontrar una palabra equivalente en el español habitual .
6. Break any of these rules sooner than say anything outright barbarous. 6) Rompe cualquiera de estas reglas antes de escribir algo que esté fuera de lugar.

Schriver, Karen A. (1989)

«Evaluating Text Quality: The Continuum from Text-Focused to Reader-Focused Methods.» IEEE Transactions on Professional Communication.

Duarte, M. E. C.; Rosa, C.; Rebelo, F.; Duarte, C. (2009)

Design of pictograms: a comparison between iterative and non-iterative design methodologies. Conference Paper · January 2009

TCurso Comunicación Técnica MU
/

? Curso de tres días en Junio

¡Ya está a aquí! Conjuntamente con Mondragon Unibersitatea hemos organizado un curso presencial de Comunicación Técnica de tres días de duración con el añadido de dos módulos de e-Learning del sistema TCTrain-Net.

Temas de actualidad y relevancia para responsables de contenidos de empresas industriales y de software. Marco legal, comprensibilidad, visualización, estrategia de contenidos e industria 4.0. ¡Con ponentes de referencia!

Haz clic en el siguiente link para leer toda la información sobre el curso y para apuntarte. ¡No os lo podéis perder!

Cuidemos los signos de puntuación
/

Elogio al signo ortográfico olvidado [regalo por Año Nuevo]

¿Ya sabéis de quién estoy hablando? ¿Os lo podéis imaginar? Pues los encontraréis en este primer párrafo. ? ¡Claro que sí!

Los signos de apertura de interrogación («¿«) y exclamación («¡«) están en peligro de extinción y esto ocurre también entre los comunicadores técnicos.  ?

Me encuentro todos los días con e-mails de «protectores de teclas» que se comen estos dos signos. Aquí no lo entiendo mucho: se supone que un buen comunicador técnico debería tener buenos conocimientos de mecanografía… Pero es al parecer una suposición mal hecha.

Y si vamos al mundo de la comunicación móvil… el horror. No sé qué han pensado los diseñadores de los teclados de móviles. ¿Tan difícil es saber que si mantienes pulsado el signo de cierre aparece el de apertura? Parece que también…

Interrogración y exclamación abierta

Sirva pues esta breve entrada como un elogio a estos dos signos especiales y característicos del castellano. Gracias a ellos nos podemos comunicar mejor y descubrir al inicio de una frase que nos están preguntando o despertando el interés. ¿Qué pensáis?

Ya se acerca el Año Nuevo y es momento de hacer reflexiones sobre lo que hemos hecho y lo que queremos hacer. En ISTEN hemos hecho muchas cosas este año (hasta el punto de dejar abandonado el blog…). También podemos aventurarnos a esperar un año 2019 lleno de aventuras y grandes experiencias.

Como regalo para el Año Nuevo os dejo esta reflexión: Cuidemos nuestros signos y símbolos ortográficos y eduquemos dando ejemplo golpe a golpe (de tecla).

¡Felices Fiestas! ??✨?

P.D.: Los que me conocéis ya sabéis en qué otros símbolos pienso. Los símbolos de unidades del Sistema Internacional. En la lista de las peor maltratadas ocupa la primera posición la «k» de «kilo» siempre confundida con el símbolo para «Kelvin»… ? A ver quién me explica la unidad del «Kelvingramo» («Kg»). ?