Identificación de Audiencia en Escritura Técnica
Clase 3 de 20 • Curso de Introducción al Technical Writing y Documentación de Código
Contenido del curso
Importancia de identificar a tu audiencia y fases de la escritura 🎯
Uno de los pilares del technical writing es la identificación de la audiencia a la que va dirigido tu escrito, independientemente de que sea un informe técnico o no.
¿Quiénes van a leer tus escritos? ¿Cuáles son sus perfiles? ¿Qué es lo que saben y qué es lo que no saben? Todas estas son las preguntas más importantes que debes hacer. Con base en las respuestas que obtengas podrás cubrir todas las fases de la escritura de un documento:
-
Planificación
-
Redacción
-
Revisión
En próximas clases profundizaremos un poco más en todas estas fases.
Dicho en otras palabras, definir a tu audiencia no es más que la "adaptación" de tu escritura para cubrir las necesidades, intereses y antecedentes de la gente que leerá tus escritos.
Foto por Clker-Free-Vector-Images en Pixabay
Analiza a tu audiencia 🕵️♀️
En un proceso de documentación global se invierte mucho tiempo y esfuerzo en definir la audiencia, lo hacemos a través de encuestas, análisis de la experiencia de los usuarios, documentación de pruebas, entre otras. Para fines prácticos de este curso, vamos a hacerlo de una manera sencilla, con algunas preguntas básicas que enlisto a continuación:
-
¿Quién es tu audiencia? ¿Quiénes serán tus lectores?
-
¿En cuál compañía trabajan? ¿Cuál es su rol?
-
¿Cuál es su profesión? ¿En qué área son expertas?
-
¿Qué necesitan? ¿Cuál es su interés por cubrir?
-
¿Cómo usará tu audiencia la información de tus escritos?
-
¿Cuál es el perfil técnico de tu audiencia? ¿Qué saben y qué no saben sobre tu tema?
-
¿Hay alguna limitación técnica entre tu audiencia y tu proyecto de escritura?
Quizá estas preguntas te parezcan muy absurdas, pero te doy un consejo: jamás des por sentado algo. Hay tantas cosas que dejamos pasar de largo porque creemos que son bastante obvias, cuando la realidad es que son de los puntos en los que más debemos de prestar atención. La falta de análisis y la adaptación de la escritura son de los problemas más comunes en documentos profesionales. Dirigirse a un público equivocado puede ser bastante complicado.
Todo lo anterior podría resumirse en una simple ecuación:
Buena documentación = conocimientos y habilidades que tu audiencia necesita - conocimientos y habilidades que tu audiencia tiene
Tipos de Audiencia 👨👩👧👦
Identifica los tipos de audiencia, los roles son una aproximación para definirlos. La división más común es la siguiente:
-
Expertos: personas que conocen la teoría y el producto por dentro y por fuera.
-
Técnicos: personas que construyen, operan, mantienen o reparan lo que los expertos diseñan.
-
Ejecutivos: personas que toman decisiones comerciales, económicas, administrativas, legales, gubernamentales y/o políticas sobre las cosas con las que trabajan los expertos y técnicos.
-
No técnicos: personas que tienen curiosidad por un asunto técnico específico y quieren aprender sobre él, pero sin ninguna razón específica o práctica.
Las personas dentro de un mismo rol normalmente tienen compatibilidad en ciertas habilidades y conocimientos técnicos. Por ejemplo, la mayoría de ingenieros de software conocen algoritmos, estructuras de programación, rendimiento de algoritmos, notación Big-O y al menos un lenguaje de programación. Sin embargo, el hecho de que conozcan acerca de notación Big-O no es sinónimo de que los roles no técnicos conozcan de qué trata esta.
Otro ejemplo es cuando leemos una publicación en el periódico relacionada con alguna investigación. Este artículo evidentemente usará un lenguaje dirigido a un público no especializado. Por otro lado, el informe de investigación para científicas o profesionales del tema tendrá un aspecto diferente.
Escribir sería más sencillo si todo el mundo compartiera el mismo rol y conocimiento, pero lamento informarte que no es así. Ismael es experto en Ruby. Ana es experta en Android. A Héctor le encanta Linux. Facundo sabe mucho de Python. Con esto quiero decir que los roles son insuficientes, por lo cual, también debes de considerar la proximidad de tu audiencia al conocimiento de cada uno.
Ejemplo: analicemos la audiencia de QIUB 😎
Vamos a hacer un ejemplo de análisis de audiencia para el proyecto ficticio QIUB.
Mi audiencia se divide en:
-
Ingenieros de Software
-
Ejecutivos
La proximidad de conocimiento en mi audiencia es la siguiente:
-
Mi audiencia conoce las API de QIUB que son parecidas a las API de LEXO (otro proyecto ficticio).
-
Mi audiencia conoce teóricamente el lenguaje de programación Python, pero toda su vida solo han programado proyectos en JavaScript.
-
Mi audiencia sabe de matemáticas discretas, pero necesitan repasar el tema de árboles.
Para determinar lo que tu audiencia necesita para cumplir la ecuación que te presenté líneas atrás la recomendación es que escribas en una lista todo lo que tu audiencia necesita aprender. Por ejemplo:
-
Usar la API de QIUB para agrupar productos por categoría.
-
Usar la API de QIUB para agrupar clientes por sector.
-
Usar la API de QIUB para agrupar los productos más consumidos.
Siguiendo estos pasos introductorios estoy segura de que tu audiencia será más clara y así evitarás escribir para un público erróneo.
Ejercicio: mejora un texto de introducción a Python 🐍
Imaginemos que el siguiente texto va dirigido a personas que nunca en su vida han programado y que tendrán su primer acercamiento a la programación a través de Python. ¿Cómo lo mejorarías?
"Python es un lenguaje de programación divertido, extremadamente fácil de usar y que en los últimos años se ha vuelto muy popular. Es un lenguaje de programación interpretado cuya filosofía hace hincapié en una sintaxis simple y es multiparadigma, esto nos dice que Python es un lenguaje que soporta más de un paradigma, suponiendo paradigma como modelo de desarrollo, debido a que soporta orientación a objetos, programación imperativa y en menor medida programación funcional. Es interpretado de tipado dinámico y multiplataforma".
¡Deja tu propuesta en los comentarios! En la próxima clase aprenderemos a investigar y hacer entrevistas para recopilar información. 🔜
