REDACCIÓN PARA USUARIOS FINALES

DOCENTE : ING. CRISTOPHER IMAR VERA BARRANTES

 Para los miembros del personal de apoyo, la redacción para los usuarios finales puede adoptar una variedad de formas.
Es posible que se requiera que los agentes de soporte preparen informes del proyecto para los colegas y creen
documentos para su uso en la capacitación del usuario final. Además, los equipos de soporte (y los proveedores de
hardware y software) a menudo comunican información esencial a los usuarios en una variedad de documentos en línea,
como sistemas de ayuda, asistentes (asistentes), páginas web, preguntas frecuentes, mensajes de correo electrónico,
sesiones de chat y archivos README.
 La creación de cualquier documento dirigido a los usuarios finales, ya sea impreso o en línea, requiere algunas
habilidades técnicas básicas de redacción. El objetivo de la redacción técnica es producir documentos que comuniquen
de manera eficaz y eficiente la información que necesitan los lectores. La documentación es cualquier forma de
comunicación escrita destinada a proporcionar información de soporte al usuario a los usuarios finales o compañeros
de trabajo. Una buena documentación ahorra tiempo a los usuarios y compañeros de trabajo; una documentación
deficiente puede costar tiempo, provocar errores y reducir la productividad. Este capítulo proporciona una descripción
general de varios temas importantes en la redacción técnica, incluidas estrategias para redactar documentos para
usuarios finales y enlaces para redactar con éxito sobre temas técnicos en un puesto de soporte al usuario.
TIPOS DE DOCUMENTOS DE USUARIOS

 Es posible que se solicite a los miembros del personal de asistencia al usuario que produzcan materiales escritos en una variedad de
situaciones. Aunque la redacción técnica puede tener varios propósitos y puede aparecer en formatos muy diferentes, todos los
documentos deben comunicar claramente un mensaje.
 Folletos y volantes
 Boletines
 Folletos y ayudas de capacitación
 Guías de usuario, manuales y manuales
 Sistemas de ayuda en línea
 Correo electrónico, chat y mensajes de texto
 Páginas web
 Propuestas, cartas y memorandos
 Documentación operativa y de procedimiento
 Guías De resolución de problemas
FOLLETOS Y VOLANTES

 Los folletos y volantes se utilizan a menudo para promover diversos eventos relacionados con la tecnología,
como sesiones de capacitación del personal, ferias de computadoras y carreras, demostraciones de productos de
hardware y software y charlas de oradores invitados. Estos documentos son principalmente promocionales y
están destinados a captar la atención del lector y "vender" el evento. Debido a que los miembros del personal de
apoyo a menudo participan en la organización de este tipo de eventos, es posible que necesiten crear anuncios
informativos para ellos. Para acelerar la entrega y reducir el uso de papel y los costos de envío, los grupos de
apoyo a menudo envían anuncios de eventos por correo electrónico o publican anuncios en una intranet o portal
web de la organización.
BOLETINES

 Son una forma importante muchos equipos de soporte se comunican con los usuarios. El personal de soporte
puede utilizar software de autoedición o procesamiento de texto para crear boletines con imágenes integradas,
como diagramas, imágenes, iconos y gráficos. Los boletines de soporte al usuario son especialmente populares en
organizaciones grandes donde el personal de soporte no entra en contacto directo con la mayoría de los
empleados de forma regular. Un número cada vez mayor de organizaciones distribuye boletines en línea a sus
empleados y clientes.
FOLLETOS Y AYUDAS PARA LA CAPACITACIÓN

 Los folletos y las ayudas para la capacitación están destinados principalmente a resumir y promover el recuerdo
del material cubierto en una sesión de capacitación. También pueden distribuirse en línea o mediante una
biblioteca de preguntas frecuentes. Los folletos impresos de diapositivas de PowerPoint con espacio para que los
participantes tomen notas junto a cada diapositiva son ayudas de capacitación comunes. Los folletos y las ayudas
de capacitación suelen ser breves y tratan un solo tema, como cómo realizar un conjunto de tareas en una
aplicación de software específica.
GUÍAS DE USUARIO Y MANUALES

 Las guías de usuario, manuales y manuales de computadora son ejemplos más formales de documentos escritos. Para algunos grupos de apoyo,
estos documentos pueden tener decenas o cientos de páginas y, a menudo, se imprimen en formato de libro o se crean como PDF (formato de
documento portátil) para su distribución en línea o por correo electrónico. A menudo están diseñados para complementar la documentación del
proveedor y los libros comerciales con información específica de una organización o instalación informática. Por ejemplo, una organización puede
emitir un manual del usuario que especifique las reglas básicas para el uso y abuso de la computadora, y detalla qué instalaciones y servicios
informáticos están disponibles para los trabajadores, incluida información sobre cómo acceder a ellos, cómo obtener software para conectarse a
la red virtual de la organización. red privada (VPN) y cómo obtener asistencia para el usuario. En las instituciones educativas, los departamentos
de TI pueden publicar guías similares para estudiantes, profesores y administradores. Incluso las organizaciones muy pequeñas consideran que una
guía de usuario impresa es una forma eficaz de comunicar información básica a los nuevos empleados y a aquellos que solo son usuarios
ocasionales.
 Los desarrolladores de software y los proveedores de hardware publican una variedad de guías de usuario y manuales de tecnología que
describen cómo instalar y utilizar sus productos. Estos manuales pueden estar organizados en un formato tutorial, que guía al usuario paso a paso
a través de las características de una tecnología, cubriendo primero las características de uso frecuente. Otros manuales están organizados en un
formato de referencia, que reúne toda la información sobre un tema específico en una sola página, sección o capítulo.
 Un formato de tutorial es conveniente para los nuevos usuarios, porque enfatiza la secuencia natural para aprender cada paso, comenzando con
las tareas más simples. Las funciones se introducen a medida que los usuarios las necesitan para una tarea en particular. La información sobre la
impresión, por ejemplo, puede estar dispersa a lo largo de un manual tutorial, a medida que se introducen varias funciones y opciones de
impresión. Las funciones básicas de impresión pueden explicarse antes y las funciones más avanzadas o poco utilizadas se tratan más adelante.
Para los usuarios experimentados, un formato de referencia suele ser más útil, porque toda la información sobre la impresión, incluida una
descripción de todas las opciones disponibles, generalmente se encuentra en una sola sección o capítulo dentro del manual. Algunos manuales
combinan tutoriales con una guía de referencia para abordar las necesidades de ambos tipos de usuarios.
SISTEMAS DE AYUDA EN LÍNEA

 Los sistemas de ayuda en línea y los asistentes de software (asistentes) son características comunes en el software de la aplicación. A veces se suministran en
CD o DVD, que los clientes pueden utilizar para su autoaprendizaje. En otros casos, los módulos de ayuda están disponibles a través de un enlace a un sitio
web o están integrados en una aplicación y se instalan al mismo tiempo que el propio software. Algunos sistemas de ayuda en línea están bien redactados y
pueden competir eficazmente con los manuales impresos o reemplazarlos como fuente de información precisa y bien organizada. Sin embargo, escribir
documentación en línea es un arte porque la información debe presentarse de manera sucinta. Los materiales de capacitación impresos generalmente se
organizan secuencialmente con menos preocupación por la longitud de cada sección. En la documentación en línea, los temas individuales deben dividirse en
secciones más cortas que pueden aparecer en una sola página de pantalla; Es poco probable que los lectores dediquen tiempo a buscar información en un
sitio web donde el texto aparece en una página muy larga en lugar de en páginas más cortas divididas en temas. Muchos sitios web también tienen ahora
versiones formateadas especialmente para usuarios de dispositivos móviles.
 Los hipervínculos y las búsquedas de índices en documentos en línea son herramientas poderosas que ayudan a los usuarios a acceder rápidamente a la
información necesaria. Un hipervínculo (también llamado simplemente un enlace) es una palabra o frase resaltada en un documento, que cuando se hace clic,
lleva al usuario a información adicional sobre la palabra o frase, mostrando una página web diferente, abriendo un documento, saltando al otra ubicación en la
página actual, o abriendo una ventana emergente. Una función de búsqueda de índice permite al usuario ingresar una palabra clave o frase de interés; el
sistema de ayuda busca y muestra información detallada sobre el tema.
 A pesar de la creciente popularidad y conveniencia de los documentos en línea, algunos usuarios prefieren los medios impresos cuando necesitan leer
grandes cantidades de información. La información impresa suele ser más fácil de leer durante períodos prolongados y se puede leer incluso cuando no se
dispone de una PC o un dispositivo móvil. Dependiendo de la calidad y resolución de la pantalla de visualización y de la iluminación de la habitación, los
documentos en línea extensos pueden resultar difíciles de leer. Algunos usuarios necesitan más tiempo para familiarizarse con el uso de documentos en línea
y cambiar su preferencia por los materiales impresos.
CORREO ELECTRÓNICO, CHAT Y MENSAJES DE TEXTO

 La capacidad de comunicarse de manera efectiva por correo electrónico, mensajería instantánea (chat) y mensajes de texto es una habilidad de escritura
importante para los especialistas en soporte al usuario, especialmente aquellos que trabajan en una mesa de ayuda que se comunica principalmente con
usuarios en línea. Muchas organizaciones de soporte han cambiado su método principal de comunicación con los usuarios de interacciones telefónicas o cara
a cara por correo electrónico, chat e interacciones basadas en la web.
 Es probable que los agentes de soporte que trabajan con clientes internos hagan un uso frecuente de mensajes de texto. En estas organizaciones, los
especialistas de apoyo que perfeccionaron sus habilidades verbales a expensas de sus habilidades de escritura pueden encontrar que necesitan actualizar sus
habilidades. El correo electrónico, el chat y los mensajes de texto pueden parecer métodos de comunicación menos formales; sin embargo, cualquier
mensaje escrito de un miembro del personal de la mesa de ayuda presenta una imagen tanto del agente como de la organización, y debe reflejar buenas
habilidades de redacción técnica.
 Saltar un mensaje escrito compuesto por algunas frases desorganizadas con errores ortográficos y gramaticales puede dar al destinatario una mala impresión
del trabajador de apoyo, así como de toda la organización de apoyo. Escribir una respuesta cuidadosa a un usuario ayuda a un agente de soporte a organizar
sus pensamientos y brinda la oportunidad de revisar y revisar una respuesta antes de enviarla. Aunque el correo electrónico interno y otros mensajes
pueden ser menos formales que los mensajes destinados a destinatarios fuera de una organización, incluso estos mensajes proyectan una imagen del
remitente. Recuerde que una vez que haya enviado un correo electrónico u otro mensaje, no tiene control sobre a dónde se puede reenviar. Los
supervisores pueden revisar y evaluar la calidad del correo electrónico de soporte, el chat y los mensajes de texto como una medida de las habilidades de
comunicación y promoción de un agente.
 Al enviar mensajes de texto, los agentes de soporte deben evitar generalmente el uso de abreviaturas (por ejemplo, u en lugar de usted, por cierto como
sustituto de dicho sea depaso,o en mi humilde opinión como un sustituto de en mi humildeopinión),a menos que una El trabajador de apoyo está seguro de
que el destinatario comprende la abreviatura y la situación claramente no requiere una respuesta más profesional.
PÁGINAS WEB

 Debido a que muchos documentos escritos para usuarios terminan en la web, la capacidad de escribir para ese
medio es una habilidad importante para los trabajadores de soporte. Las páginas web deben estar organizadas y
escritas para que los usuarios puedan localizar información rápidamente. Dado que un sitio web suele ser
accesible para el público en general, está en juego la imagen de una organización. Piense cuánto tiempo suele
permanecer en un sitio web que está mal organizado, contiene información incorrecta o proporciona enlaces
rotos (URL que apuntan a páginas web inactivas). En general, los materiales diseñados para el acceso a la web
deben ser muy cortos, con hipervínculos que lleven a los lectores a información adicional. Los materiales
basados en la web deben estar bien redactados porque los usuarios de la web a menudo no tienen la paciencia
para leer un documento largo para encontrar la información que necesitan. Tienden a hojear rápidamente y luego
hacer clic en un enlace a otro sitio si no encuentran la información que buscan. Otro desafío para los agentes de
soporte que mantienen o contribuyen a los sitios web de soporte es mantener la información precisa y
actualizada. La información de soporte obsoleta o inexacta a menudo es peor que la falta de información.
PROPUESTAS, CARTAS Y MEMOS

 Los miembros del personal de apoyo tienen que ser capaz de escribir propuestas claras y eficaces, informes,
cartas, memorandos y otros documentos de la empresa. Los especialistas de soporte que realizan evaluaciones
de necesidades para departamentos o usuarios individuales con frecuencia necesitan presentar los resultados de
sus investigaciones en forma de propuesta o informe. Además, el personal de soporte a menudo necesita escribir
cartas, memorandos y otra correspondencia a colegas, usuarios finales (tanto dentro como fuera de una
organización) y supervisores. La capacidad de escribir documentos comerciales estándar es una habilidad de
comunicación básica de soporte al usuario.
DOCUMENTACIÓN OPERATIVA Y DE PROCEDIMIENTO

 Los documentos operativos y de procedimiento incluyen pasos a seguir y listas de verificación para realizar una
tarea, y generalmente están destinados a uso interno. Las descripciones de los pasos para instalar hardware y
software que aparecen en el Capítulo 10 son ejemplos de documentos de procedimientos técnicos. Incluso para
documentos internos como estos, las habilidades de redacción técnica son esenciales. Los documentos de
procedimiento y operativos que no son claros, están mal organizados o cuestan tiempo del personal incorrecto,
dan lugar a errores y aumentan la frustración del usuario. Los documentos claros y bien organizados comunican
información de manera eficiente y reflejan bien al redactor y la organización de apoyo. Muchos especialistas de
soporte que nunca se han considerado escritores disfrutan del desafío de redactar documentos de procedimiento
y operativos que sean precisos y fáciles de seguir.
GUÍAS DE RESOLUCIÓN DE PROBLEMA

 Los miembros del personal de soporte a menudo escriben guías de resolución de problemas para ayudar a los compañeros de trabajo y clientes a resolver problemas. Ejemplos comunes
de guías de resolución de problemas incluyen:
 Un capítulo de resolución de problemas en una guía de usuario.
 Los documentos operativos y de procedimiento incluyen pasos a seguir y listas de verificación para realizar una tarea, y generalmente están destinados a uso interno. Las descripciones
de los pasos para instalar hardware y software que aparecen en el Capítulo 10 son ejemplos de documentos de procedimientos técnicos. Incluso para documentos internos como estos,
las habilidades de redacción técnica son esenciales. Los documentos de procedimiento y operativos que no son claros, están mal organizados o cuestan tiempo del personal incorrecto,
dan lugar a errores y aumentan la frustración del usuario. Los documentos claros y bien organizados comunican información de manera eficiente y reflejan bien al redactor y la
organización de apoyo. Muchos especialistas de soporte que nunca se han considerado escritores disfrutan del desafío de redactar documentos de procedimiento y operativos que sean
precisos y fáciles de seguir.

 Una página de preguntas frecuentes para un sitio web

 Un script de soporte al usuario para manejar un tipo específico de incidente de problema
 Un informe de problema y una solución en una base de conocimientos de la mesa de ayuda
 Aunque este tipo de documentación es a menudo para uso interno, debe ser claro, conciso y bien redactado.
 ¿En qué difiere la escritura técnica de otra escritura? Cada tipo de redacción técnica descrita anteriormente es una forma de documentación de apoyo. Tienen más similitudes que
diferencias. Las siguientes secciones discuten las similitudes, incluyendo cómo la escritura técnica en general difiere de otros tipos de escritura.
ESTILO DE REDACCIÓN TÉCNICA

 La redacción técnica suele seguir pautas de estilo específicas. El objetivo de estas pautas es ayudar a los escritores a crear documentos
que sean claros, precisos y accesibles para los usuarios. Tenga en cuenta los siguientes puntos al escribir documentos:
 La redacción técnica utiliza oraciones cortas y declarativas, frases breves y listas, en lugar de oraciones largas con palabras o frases
innecesarias. En general, las oraciones simples son preferibles a las compuestas. Una oración simple tiene un sujeto y un verbo, y
expresa una idea completa. Oraciones compuestas contienen dos sujetos y dos verbos, a menudo incluir y, o sino como un conector, y
expresan dos pensamientos completos. Evite las oraciones corridas y las estructuras de oraciones demasiado complejas con múltiples
cláusulas y modificadores. Compare los siguientes ejemplos:
 Oración simple: paréntesis le permiten controlar cómo Excel usa los operadores en una fórmula.
 Oración compuesta: los paréntesis le permiten controlar cómo Excel usa operadores aritméticos en una fórmula y pueden hacer que las
ecuaciones sean más fáciles de leer o revisar.
 Oración continua: si especifica un número impar de paréntesis en una fórmula o un par de paréntesis que no coinciden, Excel muestra el
mensaje "Los paréntesis no coinciden o Error en la fórmula" y luego resalta la ubicación del error que puede corregir en la barra de
fórmulas.
ESTILO DE REDACCIÓN TÉCNICA

 La redacción técnica comienza con el punto más importante al principio de una sección y no al final, como en
otros tipos de redacción. El objetivo de la redacción técnica no es generar suspenso o trabajar hacia un chiste,
sino comunicar la información de la manera más clara y eficaz posible, en la secuencia que el lector la necesita, y
ayudar al lector a realizar transiciones entre temas.
 La redacción técnica a menudo comunica secuencias paso a paso de eventos o tareas. El estilo y el formato de
escritura utilizados pueden ayudar o dificultar la comprensión de la secuencia por parte de los lectores. Por
ejemplo, se debe enumerar una secuencia de pasos en el orden en que los usuarios realizarían los pasos.
Compare los siguientes ejemplos:
 Ejemplo 1:haga clic en la opción Margen en Configurar página en el menú Archivo.
 Ejemplo 2:en el menú Archivo, haga clic en Configurar página y luego en la opción Margen.
ESTILO DE REDACCIÓN TÉCNICA

 En el primer ejemplo, las acciones aparecen en orden inverso a cómo se realizan realmente. Un usuario debe leer hasta el final de la
oración antes de saber qué acción realizar primero. El segundo ejemplo es preferible porque las acciones se enumeran en el orden en
que se realizan. Cuando los pasos de un procedimiento o tarea deben realizarse en una secuencia específica, una lista numerada puede
enfatizar la secuencia. Cuando la información no tiene un orden obligatorio, una lista con viñetas es más apropiada.
 La redacción técnica debe ser concisa, pero no críptica. La redacción concisa es breve, pero cubre la información esencial que necesita
un usuario. Los lectores de documentos técnicos suelen querer abrir un documento, encontrar la información que necesitan y volver al
trabajo. Si tienen que dedicar un tiempo innecesario a la búsqueda de información oculta, su productividad se reduce. Para incluir
información más detallada, agregue enlaces o referencias cruzadas a la ubicación donde un usuario puede encontrar más información. En
los documentos en línea, los hipervínculos mueven efectivamente al usuario de información general a más específica sobre un tema.
 El objetivo de la escritura técnica no es divertir a los lectores con humor ni llamar la atención sobre la personalidad o las preferencias
del escritor. Es probable que algunos lectores malinterpreten el humor en un documento técnico, especialmente aquellos que son
nuevos en un tema o para quienes el inglés es un segundo idioma. En la redacción técnica, las preferencias personales del escritor deben
estar claramente etiquetadas como tales, lo que permite a los lectores identificar rápidamente las posibles fuentes de sesgo.
 La redacción técnica exitosa sigue estas pautas para garantizar que los usuarios obtengan la ayuda que necesitan de un documento. Si los
usuarios no pueden localizar la información que necesitan, el resultado es un mayor volumen de contactos con el grupo de apoyo y
probablemente un mayor nivel de frustración del usuario.
CÓMO SE ORGANIZAN LOS DOCUMENTOS TÉCNICOS

 Los documentos técnicos se organizan habitualmente de forma secuencial o jerárquica. La organización secuencial
sigue un enfoque paso a paso mediante el cual la información se organiza en el orden en que se ejecutan los
pasos. Los documentos de procedimiento suelen seguir una organización secuencial. La organización jerárquica
fluye de arriba hacia abajo y la información se organiza de general a específica. Los sistemas de ayuda en línea
suelen utilizar una organización jerárquica.
PLANIFICACIÓN DE DOCUMENTOS

 La mayoría de los documentos técnicos exitosos utilizan una combinación de estrategias de organización secuenciales y jerárquicas, según el material que se va a comunicar, el medio de comunicación y las
necesidades de los usuarios. Una organización común para un documento técnico es:
 Introducción
 Propósito del documento
 Quiénes son los lectores previstos del documento
 Por qué leer el documento
 Cuerpo
 Pasos de tareas específicas
 Problemas comunes que encuentran los usuarios
 Resumen
 Revisión de los puntos principales
 Vínculos o referencias a información adicional
 La organización general es jerárquico. En el nivel superior, las secciones generales son: Introducción, Cuerpo y Resumen. El cuerpo de este ejemplo incluye pasos de tareas, que son secuenciales.
 La introducción comienza respondiendo a tres preguntas. Primero, “¿Qué aprenderé de este documento?” En segundo lugar, “¿Este documento está destinado a mí? En tercer lugar, “¿Por qué querría
alguien leer esto?”Los escritores técnicos deben responder estas tres preguntas con anticipación para ahorrar tiempo a aquellos lectores para quienes un documentoestáes nono destinado oútil. Incluso un
escrito breve, como una pregunta frecuente o un mensaje de correo electrónico, debe indicar su propósito en la primera o segunda oración.
 El cuerpo de un documento técnico debe incluir material explicativo. La mayoría de los lectores quieren una breve explicación que les ayude a comprender por qué algo funciona, qué resultado se debe
esperar o por qué la información es importante. A menudo, los escritores técnicos incluyen una breve explicación de lo que la tecnología es capaz de hacer y cómo puede ayudar a los lectores en su
trabajo. La explicación suele ir seguida de una descripción detallada de los pasos secuenciales necesarios para realizar una tarea. Finalmente, el cuerpo debe describir brevemente los problemas comunes
que los usuarios pueden encontrar y cómo recuperarse de ellos. El resumen debe ser breve: revise los puntos principales y los resultados obtenidos, y dirija a los lectores a información adicional.
 Algunos redactores técnicos se ven tentados a incluir tanta información como puedan en un documento. El escritor puede desviarse de los puntos principales para cubrir material que puede ser de interés
para unos pocos lectores, que no es crítico o es muy técnico. Omita la información menos crítica o coloque este material en un apéndice o adjunto. Incluya una referencia al apéndice en el cuerpo para
que los lectores interesados sepan dónde encontrarlo.
PLANIFICACIÓN DE DOCUMENTOS

 La planificación es esencial para producir documentos de alta calidad, independientemente de su extensión o

propósito. La mayor parte de la planificación comienza con la determinación de las características de la audiencia
y sus necesidades.
 ¿Quién es el público objetivo?
 ¿Qué sabe ya la audiencia?
 ¿Qué necesita saber la audiencia?
 ¿Qué quiere que la audiencia pueda hacer cuando termine de leer el documento?
 ¿Qué medio se utilizará para transmitir el documento a su audiencia?
 Hacer estas preguntas al principio ayuda a preparar a los redactores técnicos para crear documentos útiles y bien
orientados.
¿QUIÉN ES EL PÚBLICO OBJETIVO?

 La identificación de la audiencia objetivo a menudo ayuda a determinar el nivel de experiencia técnica de los
lectores. Escribir una descripción de la tarea para nuevos usuarios requiere diferentes suposiciones y técnicas
que escribir para usuarios más experimentados y técnicamente sofisticados. La definición de audiencia también
debe incluir una estimación de su nivel de lectura. La mayoría de los periódicos, por ejemplo, están escritos en
un nivel de lectura de octavo o noveno grado, que es un buen nivel por el que esforzarse en documentos de
computadora dirigidos a una audiencia de usuarios generales. Los documentos destinados a una audiencia técnica
pueden redactarse en un nivel de 10º a 12º grado, pero probablemente no deberían exceder ese nivel. La
mayoría de los procesadores de texto incluyen una herramienta para medir el nivel de lectura aproximado (índice
de legibilidad) de un documento.
¿QUÉ SABE YA LA AUDIENCIA?
 Para determinar quién es la audiencia, un escritor técnico debe intentar conocer los antecedentes de los
lectores, incluido lo que ya saben. Una declaración en la introducción sobre lo que el escritor asume que los
lectores ya saben puede ayudar a los lectores a tomar una decisión informada sobre si el material está destinado
a ellos, si cubre cosas que ya saben o si cubre información técnica que está más allá de su capacidad de
comprensión. Considere el siguiente ejemplo:
 La información de esta hoja de referencia es para usuarios de PowerPoint que tienen un conocimiento básico de los conceptos de
software de presentación y necesitan una herramienta de referencia para las características más utilizadas en PowerPoint.
 Cuando se escribe para lectores que necesitan conocer un procedimiento específico, a veces es difícil evaluar qué
habilidades ya tienen. En algunas situaciones, un redactor técnico puede evaluar las habilidades mediante un
cuestionario. Sin embargo, debido a que un cuestionario no siempre es factible, siempre cubra las habilidades más
básicas primero, pero con los títulos de sección apropiados para que los usuarios más capacitados puedan pasar
fácilmente a lo que necesitan saber.
¿QUÉ NECESITA SABER LA AUDIENCIA?

 Responder esta pregunta es un paso crítico en la redacción técnica porque ayuda al escritor a definir el propósito
de un documento. El propósito de un documento técnico debe ser mover a los lectores de lo que ya saben a lo
que necesitan saber. El propósito de un documento debe indicarse al principio, dentro de las primeras oraciones.
Considere el siguiente ejemplo:
 Los pasos a continuación ayudarán a un nuevo usuario de navegación GPS a descargar e instalar una versión actualizada de mapas y
datos en su dispositivo GPS.
¿QUÉ DESEA QUE LA AUDIENCIA PUEDA HACER?

 Un escritor técnico debe saber qué tareas específicas quiere que realice la audiencia después de leer el
documento. Un enfoque de tarea da dirección a la escritura y ayuda a los usuarios a saber cuándo han dominado
con éxito la información. Aunque algunos documentos están destinados únicamente a fines de información
general, la mayoría tienen como objetivo llevar al lector a un punto en el que pueda tomar una decisión o realizar
una tarea específica. Considere el siguiente ejemplo:
 Siga el procedimiento a continuación para buscar y descargar nuevas aplicaciones de la tienda de aplicaciones.
¿QUÉ MEDIO SE UTILIZARÁ PARA TRANSMITIR EL DOCUMENTO A
SU PÚBLICO?

 El medio que se utilizará para transmitir un documento a su audiencia debe determinarse antes de redactar el
documento. Los tipos de medios comunes incluyen formatos impresos y en línea. Aunque algunos documentos
están escritos para uno o ambos medios de comunicación, los documentos impresos son a menudo más tiempo
y, por tanto, las transiciones necesitan entre temas y niveles de información a los lectores de ayuda saber dónde
están en la jerarquía de la información. Los documentos en línea deben ser más cortos, pero pueden incluir
hipervínculos para ayudar a los lectores a navegar rápidamente hacia la información deseada. Los documentos a
los que se accederá a través de dispositivos móviles con pantallas más pequeñas deben dividirse en segmentos
muy cortos. Los documentos impresos extensos deben incluir una tabla de contenido y un índice para ayudar con
la búsqueda de información. De manera similar, los sitios web más efectivos son aquellos que incluyen un mapa
del sitio o capacidad de búsqueda para ayudar a los usuarios a navegar si no pueden encontrar información de
otra manera.
EL PROCESO DE REDACCIÓN TÉCNICA

 Una vez que los redactores de documentos han definido la audiencia, el propósito y el medio de un documento, pueden comenzar a
redactar el contenido. Muchos escritores siguen el proceso de siete pasos:
 Genere una lista de ideas o características importantes que se cubrirán.
 Organice la lista de ideas en una secuencia lógica y jerárquica para formar un esquema.
 Expanda el esquema en un primer borrador.
 Edite el borrador una o más veces para mayor claridad.
 Organice una revisión externa del documento.
 Revise el borrador a su forma final.
 Revise el documento final.
 Este proceso sigue una buena redacción técnica. Un escritor puede tener la tentación de tomar atajos debido a limitaciones de tiempo,
pero una vez que se publica un documento, especialmente en un medio impreso, las oportunidades para cambiarlo son raras. Incluso los
escritores muy experimentados nunca considerarían lanzar un primer borrador a los usuarios; se dan cuenta de que todo el proceso de
siete pasos es fundamental para producir documentos de calidad.
PASO 1: GENERE UNA LISTA DE IDEAS

 Algunos escritores usan un procesador de texto para generar una lista de ideas; otros usan papel y lápiz. En esta
etapa, un escritor de lluvia de ideas (a veces con colegas) para identificar tantos temas como ella puede pensar en
que podría ser útil para los lectores. Algunas ideas se convertirán en temas importantes, otras se convertirán en
temas menores y algunas se descartarán. Durante la lluvia de ideas, la estrategia es no excluir nada; Después de la
lluvia de ideas, la lista de ideas se puede priorizar, reorganizar y reducir a lo esencial.
PASO 2: ORGANIZAR LA LISTA DE IDEAS EN UN ESQUEMA

 Una vez que los escritores tienen una lista de temas que incluye todo lo que quieren cubrir, organizan los temas
en un orden lógico para formar un esquema. La mayoría de los escritores no se conforman con una estructura
organizativa final en el primer intento. La flexibilidad es importante durante los primeros pasos organizativos; los
escritores a menudo cortan y pegan para probar diferentes secuencias de ideas. La mayoría de los procesadores
de texto tienen una función de delineación que facilita la reorganización de temas, para promover algunos en
importancia a temas importantes y degradar otros. A medida que los escritores comienzan a crear un esquema,
es posible que se les ocurran otros temas que se pueden agregar. La pregunta más importante que responde un
esquema es "¿En qué orden necesita el lector conocer esta información?" En primer lugar, cubra la información
esencial, incluidos los calificadores o suposiciones.
PASO 3: EXPANDIR EL ESQUEMA EN UN PRIMER BORRADOR
 Después de crear un esquema inicial y verificar el flujo lógico, un escritor expande el esquema en un primer borrador explicando cada punto del esquema. Al
preparar un primer borrador, un escritor a menudo usa las funciones que se describen a continuación para hacer que el documento sea legible y
comprensible.
 Párrafos con frases temáticas
 Un documento debe estar organizado en párrafos, y cada párrafo debe cubrir un aspecto diferente del tema. Cada párrafo debe tener una oración temática para presentar el tema en términos
generales. Después de la oración principal, desarrolle otras oraciones en cada párrafo con detalles que apoyen o amplíen la oración principal. Al escribir documentos basados en la web y
mensajes de correo electrónico, el número de párrafos en una página o en un mensaje debe ser pequeño: uno o unos pocos.
 Transiciones
 Use palabras y frases de transición como por ejemplo, por lo tanto, y como resultado para ayudar a mostrar al lector la relación de una oración con otra. Otras transiciones útiles para los
pasos de un procedimiento son primero, segundo, siguiente, luegoy finalmente. Las transiciones ayudan a los lectores a realizar un seguimiento de dónde se encuentran en una organización
secuencial. Las listas numeradas y con viñetas también ayudan a mostrar la organización y las transiciones en un documento.
 Definir términos
 Los redactores técnicos eficaces siempre definen los términos que utilizan. Para presentar a los lectores un término nuevo, defínalo claramente y en negrita el término donde se define, como
ha visto en este libro. Tenga cuidado de no definir un término usando el término en sí; utilice un sinónimo en su lugar.
 Formatos
 Los redactores utilizan funciones de formato para ayudar a los lectores a comprender la organización de la información. Los títulos de diferentes tamaños, por ejemplo, ayudan a aclarar la
estructura general. Muchos escritores usan el tipo de letra cursiva para enfatizar, aunque el texto en cursiva debe usarse con moderación. Las listas numeradas o con viñetas son útiles para
alertar al lector sobre la estructura de una sección larga.
 La estructura de un documento ayuda a guiar a los lectores a través de las distintas secciones. Una vez que un escritor técnico determina la estructura básica de un documento, agrega formatos
para comunicar la estructura a los lectores. La siguiente lista se centra en herramientas de formato útiles que puede incorporar en su propia escritura.
 Elementos de estilo: cuando un documento está organizado en capítulos o módulos, los cambios en las fuentes, tamaños de fuente, negrita, mayúsculas, centrado, sangría, subrayados, viñetas y
numeración ayudan al lector a comprender la estructura. Estos elementos de diseño ayudan al lector a comprender qué es más o menos importante y ayudan a identificar dónde comienza y
termina cada tema. También ayudan a responder preguntas como, “Si no estoy interesado en esta sección, ¿por dónde empiezo a leer de nuevo para no perderme nada?”
PASO 4: EDITE EL BORRADOR

 Después de expandir un esquema en el primer borrador, un escritor debe leerlo y editarlo. La mayoría de los
escritores leen y editan un borrador más de una vez, buscando diferentes tipos de problemas en cada pasada. Una sola
pasada de edición rara vez detecta todos los diferentes tipos de problemas de escritura.
 A menudo se usa un pase de edición para eliminar palabras adicionales con el fin de ajustar el texto porque el objetivo
de la redacción técnica es ser breve. Considere, por ejemplo, el siguiente párrafo:
 Dediquemos un poco más de tiempo a discutir la relación entre el sistema de distribución automática de llamadas (ACD) y otros sistemas de
mesa de ayuda. Solo los ACD más sofisticados incluyen interfaces para otros dispositivos ahora, pero es claramente la ola del futuro, sin
mencionar un potenciador de la productividad.
 La siguiente versión elimina las palabras superfluas mientras mantiene el significado:
 Analicemos la relación entre el sistema de distribución automática de llamadas (ACD) y otros sistemas de mesa de ayuda. Actualmente, solo
los ACD sofisticados pueden conectarse a otros dispositivos. Sin embargo, los modelos futuros tendrán conectividad para mejorar la
productividad del usuario.
 La eliminación de palabras adicionales requiere práctica, pero es beneficiosa porque una escritura más estricta requiere
menos tiempo para leer. Elimine las palabras que no sean críticas para comprender su significado.
PASO 5: OBTENGA UNA REVISIÓN EXTERNA

 Una revisión externa es como una prueba beta de un nuevo producto. Un revisor a menudo plantea preguntas,
detecta inconsistencias, encuentra significados poco claros, identifica técnicas de escritura deficientes y localiza
otros problemas que el escritor no puede ver. Obtener críticas externas puede ser sorprendente, especialmente
porque los escritores que dedicaron mucho tiempo a su primer borrador a menudo están satisfechos de que sea
casi perfecto. La crítica puede ser especialmente dolorosa si un revisor no comparte el mismo estilo y enfoque
de escritura que el escritor. Pero una segunda perspectiva sobre cualquier documento escrito puede ser útil,
especialmente para los documentos que se distribuirán ampliamente. Con el tiempo, los escritores aprenden a
dejar de lado la actitud defensiva natural que pueden sentir sobre su trabajo y se dan cuenta de que un revisor
representa al público objetivo potencial. La mayoría de los escritores prefieren que un revisor señale los
problemas durante la etapa de redacción que que los lectores lo hagan después de la publicación.
PASO 6: REVISAR EL BORRADOR

 Después de que un escritor edita un borrador y recibe comentarios, lo revisa para incorporar sugerencias y
correcciones. Si un escritor es perfeccionista, uno de los desafíos en el proceso de escritura es saber cuándo
dejar de revisar. Aunque los pases de edición pueden tener un propósito útil hasta cierto punto, un escritor debe
aprender cuándo detenerse. Afortunadamente para muchos escritores técnicos, los plazos de publicación y de
proyectos dictan cuándo están terminados. Después de algunas revisiones, las pasadas de edición adicionales
generalmente dan como resultado mejoras incrementales muy pequeñas en un documento. Al final de cada
pasada de edición, un escritor debe preguntar si la última pasada resultó en una mejora sustancial, o si las
mejoras fueron sólo marginales; si no mejoraron significativamente la legibilidad o precisión del documento,
entonces es hora de dejar de revisar y revisar.
PASO 7: REVISAR EL DOCUMENTO
 Después de escribir, editar y revisar un documento, los escritores deben revisarlo una última vez para asegurarse de que no queden
pequeños errores. A veces, otra persona, posiblemente un corrector de pruebas profesional, un corrector de estilo o un colega de
trabajo, puede realizar esta tarea. La mayor parte de la redacción técnica se beneficia enormemente de la perspectiva de otro corrector
de pruebas. Los correctores buscan una variedad de errores comunes, que incluyen:
 Uso de mayúsculas y puntuación inconsistentes¿Los nombres propios se escriben en mayúsculas de manera consistente? ¿Están en
mayúsculas las palabras que no deberían estar? ¿Se usan las comas de manera consistente en las oraciones, en las listas y dentro de grandes
números?
 Espacios adicionales entre palabras y oraciones: ¿Es consistente el número de espacios después de cada oración? (La mayoría de los libros
tipográficos y muchos documentos publicados en computadoras de escritorio usan solo un espacio después de los puntos). ¿Hay un solo
espacio entre las palabras?
 Uso inconsistente de fuentes: ¿todos los títulos tienen la fuente y el tamaño correctos? ¿El cuerpo del texto tiene el mismo tamaño y tipo de
letra en todo el documento?
 Saltos de página incorrectos: ¿están todos los saltos de página en ubicaciones lógicas? ¿Deberían ajustarse los saltos de página para eliminar
oraciones huérfanas (una situación en la que la primera o la última oración de un párrafo o lista está en una página separada del resto del
párrafo o lista)?
ESTRATEGIAS DE REDACCIÓN TÉCNICA

 Aunque es posible que no haya escrito documentos técnicos antes, probablemente haya utilizado un manual,
ayuda en línea o alguna otra forma de documentación para el usuario final. Según su experiencia, probablemente
ya tenga algunas opiniones sobre lo que hace que la redacción técnica sea buena o mala, y qué ha sido o no eficaz
para abordar sus necesidades como lector y Uso inconsistente de fuentes: ¿todos los títulos tienen la fuente y el
tamaño correctos? ¿El cuerpo del texto tiene el mismo tamaño y tipo de letra en todo el documento?
 Saltos de página incorrectos: ¿están todos los saltos de página en ubicaciones lógicas? ¿Deberían ajustarse los
saltos de página para eliminar oraciones huérfanas (una situación en la que la primera o la última oración de un
párrafo o lista está en una página separada del resto del párrafo o lista)?
 usuario de tecnología. Es un placer leer algunos textos técnicos porque están bien organizados y la información
importante se presenta de forma clara y concisa. Si analiza documentos exitosos, se destacan algunas estrategias y
enfoques comunes.
ANALOGÍAS

 Los escritores técnicos suelen utilizar analogías para explicar material nuevo. Una analogía es una comparación
entre un concepto desconocido y uno familiar; una analogía destaca las similitudes entre las cosas. Por ejemplo,
los escritores suelen utilizar la analogía de un sistema de archivo de oficina para explicar la estructura jerárquica
de los medios informáticos; establecen un paralelo entre la información almacenada manualmente en un sistema
de archivo de oficina y la información almacenada electrónicamente en un sistema de archivo de computadora
(por ejemplo, un disco duro es como un archivador). Las analogías son útiles porque relacionan algo con lo que la
mayoría de los usuarios están familiarizados con algo que necesitan comprender.
REPETICIÓN

 Los escritores técnicos a menudo usan la repetición para enfatizar. La repetición también es una estrategia de
capacitación sobre la que aprenderá más en el Capítulo 11. Tanto en los documentos técnicos como en la
capacitación del usuario, es útil presentar un tema, explicarlo y luego resumirlo. La repetición ayuda a los
usuarios a aprender material nuevo y recordarlo más tarde. Sin embargo, el uso excesivo de la repetición puede
alargar innecesariamente un documento sin contribuir a su utilidad
USO COHERENTE DE LAS PALABRAS

 Los escritores técnicos tratan de utilizar las palabras de forma coherente. En la escritura creativa, a los escritores
se les enseña a buscar sinónimos para evitar el uso excesivo de ciertas palabras e inyectar variedad en el trabajo
escrito. Sin embargo, en la redacción técnica, el uso constante de palabras puede contribuir a la comprensión del
lector. Variar innecesariamente el uso de las palabras puede hacer que el lector se pregunte si diferentes palabras
indican una sutil diferencia de significado. Por ejemplo, un escritor puede usar sinónimos como DID, DID-ROM,
disco de video digitaly disco óptico de manera intercambiable para referirse a lo mismo, lo que puede confundir a
los lectores. La redacción técnica suele ser más clara cuando se selecciona una palabra entre sinónimos y se
utiliza a lo largo de un documento.
 Muchas organizaciones mantienen una hoja de estilo que enumera sus preferencias de términos comunes para
que todos los redactores utilicen una terminología coherente. A veces, una hoja de estilo es una lista simple de
términos preferidos y convenciones ortográficas. En otros casos, una hoja de estilo puede ser un documento
extenso que enumera no solo términos y convenciones ortográficas, sino también estructuras gramaticales
preferidas, convenciones de uso de nombres de productos y similares.
ESTRUCTURA PARALELA

 El concepto de estructura paralela es importante en la redacción técnica. La estructura paralela es una estrategia
de escritura en la que elementos similares en una oración, lista o tabla se tratan de manera consistente. Una
aplicación de la estructura paralela es el uso de tiempos verbales y partes del discurso consistentes. Por ejemplo,
evite las oraciones que combinen tiempos verbales y formas como: "El propósito de un programa de utilidad de
ajuste es limpiar archivos obsoletos, eliminar carpetas vacías y mejorar el rendimiento de la PC".
PROBLEMAS COMUNES DE REDACCIÓN TÉCNICA

 Los escritores técnicos aprenden de la experiencia para evitar problemas comunes para que su redacción sea
más clara, más comprensible y más fácil de leer.
DESORDEN

 La disponibilidad de potentes procesadores de texto y software de autoedición significa que incluso los escritores novatos pueden producir resultados de apariencia profesional. Sin
embargo, todos los escritores deben tener cuidado de no incluir demasiados elementos de diseño que distraigan. El hecho de que los gráficos, las imágenes prediseñadas, el sombreado,
el arte de la palabra, los bordes y los colores de impresora de neón se puedan incluir fácilmente no significa que deba usarlos todos. Agregue gráficos para ilustrar o resaltar un punto
importante, no solo para la decoración. Aplique las funciones de formato con moderación y coherencia, y solo cuando ayuden a los lectores a localizar información o comprender el
tema. Un documento con formato simple suele ser más eficaz que uno con demasiadas funciones de formato.
 Una página repleta de texto y gráficos suele ser difícil de leer. Los documentos más exitosos son aquellos que incluyen un considerable espacio en blanco donde los lectores pueden
descansar la vista. Deje márgenes razonables en la parte superior, inferior y laterales de las páginas; insertar espacios entre párrafos; y use una fuente que sea lo suficientemente grande
para ser legible. El tamaño de la fuente del texto del cuerpo debe ser de al menos diez puntos o más; no reduzca el tamaño de una fuente solo para que se ajuste a un material que sea
demasiado largo en el espacio asignado. Más bien, edite para ser conciso.
 La mayor parte del texto del cuerpo debe estar alineado a la izquierda. Los pasajes grandes de texto centrado son difíciles de leer, al igual que el texto justificado, que está alineado en
los márgenes derecho e izquierdo. El texto justificado, también llamado justificado en bloque, a veces contiene grandes espacios en blanco entre palabras que pueden dificultar la lectura
del texto. Por ejemplo, ¿cuál de estos pasajes es más fácil de leer?
 Este párrafo está alineado a la izquierda para ilustrar la facilidad con la que el ojo del lector se mueve de una palabra a otra. Este estilo de justificación se recomienda para el cuerpo de la mayoría de los
documentos porque mejora la legibilidad.
 Este párrafo está centrado
 para ilustrar que es más difícil de leer y lleva
 más tiempo leer líneas de texto que
 difieren en longitud.
 Este párrafo está justificado en bloque para ilustrar que es más difícil leer un pasaje cuando el software inserta espacio adicional entre palabras para hacer que cada línea tenga exactamente el mismo ancho. Este
enfoque crea un estilo de bloque artificial con texto que se extiende a los márgenes derecho e izquierdo.
TIPOS DE LETRA INAPROPIADOS

 Para la mayoría de los lectores, los tipos de letra serif son más fáciles de leer que los sans serif. Los tipos de letra
serif incluyen serif, que son líneas finas que se proyectan desde la parte superior e inferior de las letras de una
fuente. Estas líneas llevan el ojo de una letra a otra a través de la línea, mejorando la legibilidad. La fuente que
está leyendo ahora se llama Warnock Pro, que es una fuente serif. Los tipos de letra sans serif no tienen serifas
(sans es francés para sin). Los tipos de letra sans serif se utilizan a menudo para títulos y encabezados, mientras
que los tipos de letra serif se utilizan con frecuencia para el texto del cuerpo.
 La mayoría de las aplicaciones de procesamiento de texto ofrecen varios tipos de letra especiales que están
destinados a documentos especiales, como invitaciones, folletos o volantes. Las fuentes de script entran en esta
categoría. Los tipos de letra especiales son interesantes y divertidos, pero debe guardarlos para un uso informal
porque una fuente de escritura puede hacer que el texto sea más difícil de leer.
REFERENCIAS DE GÉNERO

 En los últimos años, ha disminuido el uso de pronombres relacionados con el género. Él, ella, ély ella a menudo
se reemplazan con palabras neutrales en cuanto al género, como ellos, suy eso. Este cambio de estilo significa que
los escritores a veces usan un pronombre plural donde antes podrían haber usado un pronombre singular.
También puede usar la frase él o ella (el orden a veces se invierte). Algunos escritores usan la forma combinada s
/ he, pero esta solución generalmente no es la preferida porque es menos común y más difícil de leer. Otros
escritores alternan entre él y ella,una estrategia que puede confundir al lector. Elija una de estas estrategias para
usar de manera consistente, pero trate de evitar palabras relacionadas con el género, a menos que encajen
claramente.
 Las palabras neutrales al género incluyen personal en lugar dede manoobra y dotadopersonal en delugar de
tripulado. Utilice presidente o presidente en lugar de presidente (a menos que presidente sea un título oficial).
Pero sea coherente: no se refiera a un hombre como presidente y a una mujer como presidente; en su lugar,
refiérase a ambos sexos como una silla. Utilice supervisor en lugar de capataz.
REFERENTES POCO CLAROS

 Otro problema común en la redacción técnica es el uso de referentes poco claros o faltantes. Un referente es
una palabra o concepto concreto que se designa con otra palabra. Palabras como this, that, it, y que son palabras
comunes que se utilizan para designar referentes. Considere el siguiente ejemplo:
 Windows y Office Suite utilizan menús contextuales desplegables. Son buenos ejemplos del poder de la interfaz gráfica de usuario.
 La palabra ellos al comienzo de la segunda oración designa o se refiere a un concepto en la oración anterior.
Pero, ¿quiere decir el escritor que Windows y Office Suite son ejemplos del poder de la interfaz GUI, o que los
menús contextuales desplegables son buenos ejemplos? El referente concreto de ellos no está claro. Para aclarar
la segunda frase, reemplazan que con el referente previsto:
 Windows y el uso de menús contextuales desplegables Office Suite. Ambos paquetes de software son buenos ejemplos del poder de
la interfaz GUI.