¿Un redactor técnico necesita formación técnica?
Respuesta corta: no.
Sin embargo, es una ventaja. Es bueno tener un conocimiento profundo del campo sobre el que escribe, para que sus documentos tengan más peso y perspicacia.
Elegiría, dado el mismo nivel de habilidad de escritura, una persona con formación técnica sobre una sin formación técnica, si lo que estoy buscando son documentos técnicos.
¿Por qué no tener la ventaja, si puedes? Asegúrate de ser un gran escritor o consigue trabajo con cualquier tema sobre el que vayas a escribir, pero consigue los trabajos.
Soy un escritor técnico experimentado que se especializa en la documentación de API. En mi experiencia, para tener éxito, un escritor técnico necesita suficiente aptitud técnica para (1) comprender las necesidades de los usuarios y (2) sondear a los expertos en la materia (SME). Si lo único que vas a hacer es repetir como un loro lo que te dicen las pymes, te vas a perder detalles importantes. Las PYMES (en cualquier campo) tienen puntos ciegos; han estado viviendo en las profundidades de su código durante tanto tiempo que pueden olvidar que las suposiciones "obvias" no son obvias. También tienden a tener un modelo particular de cómo los usuarios usarán su producto, que puede ser más especulativo que basado en la realidad. (No los estoy criticando; a menudo no tienen suficiente información). Es el trabajo del redactor técnico profundizar en todo eso. (También el probador, si tiene uno).
Cuando contrato escritores técnicos, busco un cierto umbral de habilidad de escritura, pero luego busco la aptitud técnica. Prefiero tener un escritor competente que entienda la tecnología que un escritor que produzca una prosa excelente pero que necesite mucha ayuda para averiguar qué escribir. Es más fácil ayudar al escritor competente a mejorar la escritura que ayudar a alguien a comprender profundamente la tecnología relevante.
Desde mi experiencia, no explícitamente. Pero un escritor técnico necesita entender sobre qué está escribiendo para comunicarlo de manera efectiva. Si desea un libro sobre el tema, Technical Communication de Mike Markel es un excelente recurso para todos los aspectos de la redacción técnica y la comunicación.
Yo mismo tengo experiencia técnica, pero he trabajado con algunos escritores de tecnología de primer nivel que se adentraron en el campo desde las humanidades o las ciencias sociales. En mi opinión, los mejores equipos de redacción técnica tienen una mezcla de expertos en tecnología (para proporcionar información técnica) y no expertos en tecnología (para hacer preguntas "estúpidas" útiles).
Dicho esto, una buena redacción técnica se basa en una sólida curiosidad sobre el tema. Su objetivo debe ser hacer que la tecnología sea accesible para sus lectores. Los escritores de tecnología que no sienten curiosidad o se sienten intimidados por la tecnología (¡y hay muchos!) escriben sobre cosas que apenas entienden de una manera superficial y engañosa que vuelve locos a los lectores.
Hago redacción técnica y publicaciones en el campo de la informática y, hasta cierto punto, diré que sí. Debe tener alguna idea de la tecnología si está escribiendo material original sobre una tecnología. Si está escribiendo detalles técnicos sobre el trabajo que ha hecho otra persona, creo que puede arreglárselas con buenas habilidades de comunicación con una persona que entienda los detalles del tema.
Creo que necesita alguna aptitud técnica o interés para que pueda aprender la jerga y la aplicación general del tema.
En cualquier caso, se requerirá una buena relación con un experto en la materia para que pueda obtener una segunda opinión sobre lo que ha escrito y verificar si se ajusta al tema.
La escritura técnica es un taburete de tres patas. Para hacerlo bien y de manera eficiente, necesitas tres cosas:
Conocimiento suficiente de la tarea del usuario para averiguar qué necesita saber y cómo comunicárselo.
Conocimiento suficiente de la tecnología para descubrir cómo funciona y qué necesita decir al respecto, y para hacer las preguntas correctas a los desarrolladores.
Suficiente conocimiento de escritura y publicación para crear realmente un trabajo comprensible y utilizable.
¿Pueden las organizaciones encontrar redactores técnicos con estas tres habilidades? A menudo no pueden, por lo tanto, a menudo tienen que conformarse con uno o dos.
¿Todas las organizaciones entienden que la redacción técnica es un taburete de tres patas? No, a veces solo quieren que alguien haga las palabras o alguien que haga que el documento se vea bonito.
Las organizaciones que no saben que necesitan las tres patas del taburete pasarán de un desastre de comunicaciones a otro hasta que descubran que necesitan las tres. Entonces se enfrentarán al problema de que es muy difícil encontrar una persona con los tres, sobre todo por el salario que están dispuestos a pagar.
En ese momento, tienen que decidir cuál de los tres pueden arreglárselas sin él. Esto dependerá del producto y del mercado. Si están entregando un producto de consumo, la primera etapa es bastante fácil, por lo que pueden concentrarse en las otras dos.
Si el mercado es muy técnico, puede que se centren más en el partido de ida.
Si están desesperadamente presionados por los ciclos de desarrollo en su proceso de producción, pueden centrarse en la segunda etapa para minimizar el tiempo que la comunicación técnica le quita a su programa de desarrollo.
Debido a estas diferentes reacciones a la escasez de personas con las tres habilidades que estén dispuestas a trabajar por los salarios ofrecidos, puede obtener un trabajo con solo dos, o a veces solo con una de las tres piernas, pero se abrirán diferentes oportunidades dependiendo de que piernas tienes.
Y, por supuesto, tanto la primera como la segunda etapa son más o menos específicas de industrias particulares. Puede tener un conocimiento de tareas ejemplar del software de contabilidad, por ejemplo, pero ser completamente inadecuado para la redacción técnica de dispositivos médicos.
En resumen, depende. La escritura técnica no es un producto genérico y puede estar eminentemente calificado para un trabajo y desesperadamente no calificado para otro.
Sí, un redactor técnico eficaz tendrá suficiente experiencia y conocimientos técnicos para crear contenido útil a partir del material de origen (a menudo escaso).
Sin embargo, los rasgos más importantes de los escritores técnicos efectivos son sus sólidas habilidades de escritura/comunicación y una profunda curiosidad sobre el tema y la audiencia. Esto llevará a un escritor no muy técnico a un largo camino en el trabajo.
El título de "escritor técnico" cubre una amplia gama de descripciones de trabajo. Como resultado, en el campo, los escritores técnicos que trabajan tienen una amplia gama de habilidades técnicas y requisitos de conocimiento. Cuanto menos técnico sea el tema, menos rigurosamente se aplica la perspicacia técnica.
Los escritores que trabajan con la documentación del usuario final y la ayuda a menudo tienen menos necesidad de un conocimiento profundo de la programación, por ejemplo, aunque a menudo se espera un conocimiento del campo en el que se utilizará el producto. Una experiencia en diseño de experiencia de usuario (psicología cognitiva) suele ser una ventaja. Y normalmente hay requisitos en torno a las herramientas de producción utilizadas por el equipo (Office, HTML, XML, etc.).
Entonces, la definición de "técnico" puede variar según el tema, la audiencia y el equipo.
Por otro lado, un contenido más profundamente técnico requiere una comprensión profunda del tema. No creo que un escritor sin experiencia en programación pueda escribir documentos API útiles, y la utilidad de los documentos probablemente aumente con la experiencia y el conocimiento del escritor.
He trabajado con redactores técnicos que no tenían antecedentes particularmente técnicos. En su mayor parte, podrían falsificarlo siguiendo formas y estilos y reutilizando partes y piezas de otras fuentes. Esto es, realmente, solo una edición glorificada.
Sin embargo, para ser justos, también he trabajado con escritores con antecedentes profundamente técnicos que tampoco podían escribir documentos útiles porque no eran comunicadores efectivos. Entendieron muy bien el tema, pero no pudieron transmitir de manera clara y sucinta cómo funcionaba o qué hacer con él.
Entonces el conocimiento técnico es un requisito, pero no el único.
Hay dos escenarios en los que uno podría argumentar
He realizado bastante redacción técnica para sistemas de información de atención médica. Hay dos categorías principales que puedo identificar y cada una tiene requisitos diferentes. Hay muchos proyectos entre estas dos categorías con diferentes requisitos.
Mi empresa proporciona un recurso técnico humano cuando contratamos a un escritor sin formación técnica en el área requerida. Si puede trabajar bien con un recurso técnico humano, o incluso con un recurso técnico no humano, puede reducir drásticamente su necesidad de formación técnica.
Entonces, en resumen, depende de qué tan técnico sea lo que está escribiendo y los recursos proporcionados por la entidad contratante.
Estoy a punto de rechazar un contrato bastante bueno como autor técnico (TA) que escribe API para una empresa con sede en Gibraltar : ¡sol, arena y señoritas! ¿Por qué? Porque pude pasar la entrevista basándome únicamente en mi personalidad y no en mi aptitud para el tema. Soy un TA lo suficientemente bueno como para conocer mis limitaciones y tengo experiencia previa escribiendo API, entonces, ¿por qué digo que no a un contrato que realmente necesito? La respuesta es que no creo que pueda hacerle justicia.
No tengo un conocimiento 'razonablemente' profundo de la programación ( JSON / Java / RESTful ) y tendría que apoyarme mucho en los desarrolladores para explicar cada detalle del código, exponiendo así lo tonto que era y, finalmente, desalentando a los desarrolladores. o expertos técnicos de proporcionar el material tecnológico que, como autor, debería aclarar para la audiencia.
Realmente creo que un buen autor escribe desde la experiencia, desde una sólida base de conocimiento del tema, desde una posición de fuerza. Entender tu tema hace que tu prosa fluya, y fluya con claridad y concisión. Entonces, sí, un autor técnico necesita una formación técnica en el tema sobre el que está escribiendo; aunque solo sea para que pueda obtener la cooperación de los expertos en la materia de los que obtendrá la información.
No hace falta decir que si el autor no entiende la información sobre la que está escribiendo, entonces no tendrá idea de cómo filtrar los datos y explicar claramente el tema.
No, solo necesita saber tanto como el usuario final.
En mi caso, provenía de un entorno de marketing y traducción y me convertí en el redactor técnico principal para el texto de la interfaz de usuario móvil de Samsung. Nunca tuve que escribir pautas o textos para programadores de alto nivel. Solo escribí para diseñadores de UX y para el usuario final de los dispositivos.
Las habilidades que me permitieron tener éxito en este rol fueron un impulso para comprender y simplificar tanto como sea posible y siempre encontrar razones lógicas para respaldar mis decisiones. Además de eso, recuerde que normalmente trabajará junto a un equipo o expertos en la materia que completarán los detalles por usted. Obligue a estas personas inteligentes a pensar con muchas preguntas tontas y producirá contenido extremadamente útil.
No. Estuve allí y lo hice desde ambos lados.
Un redactor técnico necesita saber lo suficiente para comprender lo que se le da o dice y convertirlo en algo útil. Su trabajo es convertir la conversación técnica en algo útil para personas no técnicas, y también formatearla en un estilo que la empresa usa para sus documentos.
El contenido debe provenir del ingeniero/programador, quien puede necesitar ayuda para obtener la información útil en una página para editarla y reescribirla. El peor de los casos sería entrevistarlos y crear el primer borrador para ellos. Más a menudo, es revisar para ver lo que realmente querían decir o para llenar los agujeros de las cosas que omitieron porque 'todo el mundo lo sabe'.
Al igual que con la enseñanza, la escritura técnica se puede describir como "el arte de impartir información sin conocimiento".
Usted es el defensor del usuario final. Sus habilidades técnicas en este caso son simplemente obtener la información necesaria de los expertos y luego presentar esa información a sus lectores, de manera que tanto los expertos como los lectores estén satisfechos con los resultados. Bromeo, bromeo.
En serio, dadas las habilidades necesarias para entrevistar, investigar y escribir (sin las cuales usted sería uno de los expertos, no uno de los escritores), un interés genuino en el área temática es útil. Por lo general, a los expertos les encanta hablar sobre sus temas favoritos y dan la bienvenida a una audiencia comprensiva.
Supongo que depende. Para escribir documentos orientados al usuario final como SAP, JDE, instrucciones de trabajo paso a paso sobre cómo hacer algo que realmente no necesita conocimientos técnicos. Necesitas aprender rápido.
No , no es necesario haber tomado clases o haber obtenido un título en su área. Lo que realmente necesitas es una curiosidad insaciable . Uno de los mejores ejemplos que conozco de esto es Martin Gardner , quien durante más de 20 años escribió una columna para Scientific American llamada Mathematical Games . Se le da mucho crédito por la popularización de las matemáticas recreativas en el siglo XX.
Según wikipedia: "Irónicamente, Gardner tuvo problemas para aprender cálculo y nunca tomó un curso de matemáticas después de la secundaria". Según recuerdo, Gardner atribuyó parte del éxito de su columna a su falta de formación en matemáticas . Cada mes para su columna, tenía que aprender sobre el tema, antes de poder enseñárselo a su audiencia.
Debe comprender (con suerte con un poco más de profundidad de lo que escribe) lo que el lector necesita saber y lo que ya entiende para que sepa qué analogías, ejemplos, nivel de detalle y otras cosas puede usar para cerrar la brecha entre eso. y el nuevo material. Por lo tanto, no tiene que ser un experto, pero sí tiene que saber adónde va si quiere llevar a alguien más allí.
Al trabajar con expertos, también debe saber lo que el lector no tiene que saber para poder filtrar detalles innecesarios y temas tangenciales.
Siempre puedes aprender algo de esto sobre la marcha, pero comenzar con una idea general del material y el trasfondo realmente ayuda.
Un ángulo ligeramente diferente es que la escritura técnica (o de cualquier otro tipo) puede tener tanto que ver con la cultura como con el contenido explícito.
Para ser más efectivo al escribir para una comunidad técnica en particular, debe comprender el tema que está cubriendo, pero también debe comunicarse en un estilo que resuene con esa comunidad. Por ejemplo, si estuvieras escribiendo sobre la escena musical contemporánea en una ciudad en particular, perderías credibilidad con los lectores si hicieras un mal uso de la jerga local o hicieras referencias obsoletas, incluso si los datos sobre las bandas locales fueran completamente correctos.
De la misma manera, las comunidades técnicas tienden a tener formas sutiles pero distintas de usar y percibir el lenguaje que pueden marcarlo como un extraño, un visitante comprensivo o "uno de los nuestros". Lea algunos escritos bien considerados para el campo en el que planea trabajar y busque ejemplos del estilo de la comunidad.
¡Sí! Pero eso no significa un título de ingeniería, y el nivel de conocimiento técnico depende del tipo de documentación. Necesita más experiencia en ingeniería y ciencias para trabajar en una empresa de ingeniería o ciencia. Es posible que necesite más estadísticas y antecedentes financieros para trabajar en un banco o redactar propuestas de subvención. Estas son algunas de las áreas técnicas que la mayoría de los escritores de documentación y propuestas necesitarán usar: Matemáticas: porcentajes, fracciones, medidas, tiempo, conversión de unidades. Ciencias: Física (elementos básicos como aceleración, fuerza). Ingeniería: normas ISO, notación científica, dibujos y símbolos de ingeniería. Software: Repositorios de código, sistemas operativos, bases de datos, tecnologías web, software y métodos de publicación.
Personalmente, tengo títulos en inglés y periodismo, pero estaría bastante perdido si no hubiera tomado clases de física, trigonometría, microbiología, química, astronomía y otras ciencias y ciencias relacionadas con la ingeniería en la escuela secundaria y la universidad. Necesitaba especialmente esa base para la escritura de ingeniería (mi trabajo actual), pero la formación técnica también era importante en los trabajos de periodismo cuando escribía sobre temas ambientales, presupuestos e impuestos gubernamentales, artículos meteorológicos y muchas otras áreas.
Mónica Celio