¿Qué es Technical Writing? Lleva tu documentación al siguiente nivel

1/20

Lectura

Technical Writing: más allá de manuales y documentación 📚

¡Te doy la bienvenida al Curso de Technical Writing y Documentación de Código con Markdown! Aprenderemos cómo documentar código siguiendo buenas prácticas para facilitar el mantenimiento y escalabilidad de tus proyectos.

No te desanimes si aún no eres una experta programadora. En realidad, el objetivo del technical writing o escritura técnica es mucho más profundo que solo la creación de manuales para software y computadoras, podemos llevar a cabo esta disciplina en cualquier campo donde necesites explicar ideas, conceptos y procesos complejos. Por esta razón, en este curso quiero compartirte todo lo que involucra trabajar como Technical Writer.

¡Soy Nancy Salazar, tu profesora de Technical Writing! 👩‍🏫

Déjame contarte un poco de mí. Mi nombre es Nancy Salazar, de profesión soy Ingeniera en Tecnologías de la Información y me especialicé en el área de Sistemas Informáticos. Soy de México y me encanta escribir desde que tengo uso de razón.

Cuando comencé mi carrera en la universidad tuve mi primer acercamiento con la magia del hardware y software. Y fue justo durante este proceso que conocí que no solo se trataba de programar y programar, sino que también tienes que documentar, algo que a la mayoría de mis compañeros les daba flojera. De hecho, algo me dice que es una actividad que sigue sin gustarles.

Nancy Salazar

Como podrás imaginar, en los trabajos en equipo en los que teníamos que desarrollar algún proyecto de software yo era la que hacía toda la documentación. Para mí era fascinante, ya que, como comenté en líneas anteriores, me encanta la escritura. No sabía que en algún punto de mi carrera iba a combinar mi amor por la escritura con el software.

A lo largo de mi trayectoria profesional me he ido involucrando en más proyectos en los que puedo colaborar como Technical Writer. Incluso escribo artículos para revistas y plataformas en línea donde trato temas relacionados con tecnología y emprendimiento, tecnología y cine… tecnología y cualquier tema. Espero que todo lo que te comparto en este curso de introducción te motive a convertirte en Technical Writer.

Definición de Technical Writing 🤓

La traducción literal de technical writing es “Escritura Técnica”. Pero vamos un poco más a las raíces, veamos qué dice la Real Academia Española (RAE) en torno al significado de la palabra Técnica con algunas de sus definiciones:

Técnico, ca

Del lat. mod. technicus, y este del gr. τεχνικός technikós, der. de τέχνη téchnē ‘arte’.

  1. adj. Perteneciente o relativo a las aplicaciones de las ciencias y las artes.

  2. adj. Dicho de una palabra o de una expresión: Empleada exclusivamente, y con sentido distinto del vulgar, en el lenguaje propio de un arte, ciencia, oficio, etc.

  3. f. Conjunto de procedimientos y recursos de los que se sirve una ciencia o un arte.

  4. f. Pericia o habilidad para usar una técnica.

¿Cómo me convierto en Technical Writer? ✊

Google dice que no hay un camino único para convertirte en technical writer. Hay una amplia gama de antecedentes educativos y profesionales que hay detrás de esta profesión. Te encontrarás con muchos ingenieros de software, ingenieras de operaciones de desarrollo, periodistas, físicos, abogadas y profesores. Somos un grupo diverso, pero todos compartimos las siguientes habilidades:

  • Escribir claramente en tu idioma natal.

  • Escribir claramente en inglés también.

  • Aprender tecnologías complejas con relativa rapidez.

  • Explicar tecnologías complejas de manera útil para el público objetivo.

  • Tener fuertes habilidades interpersonales.

  • Comprender el código de lenguajes de programación.

Nuestra misión como technical writers 🏁

En resumen, los technical writers somos híbridos raros, poseemos una mezcla poco común de talentos. Tenemos por objetivo transformar la información técnica en un lenguaje fácilmente comprensible y cumplimos este reto a través de la escritura técnica, obteniendo como resultado información útil, puntual y fácil de interpretar.

Pero ¿para qué todo esto?

Ayudamos a las personas a utilizar aplicaciones informáticas, evaluar una condición médica, prevenir accidentes, operar equipos industriales, entre muchas otras funciones. Transmitimos información técnica de manera escrita y fácilmente comprensible para todas las personas.


¿Sabías en qué consiste technical writing? ¿Has colaborado escribiendo documentos técnicos en algún proyecto interesante? ¿O estás emocionada por descubrir este nuevo mundo desde cero? Estoy encantada de conocer tu experiencia en este trabajo y ayudarte a descubrir cómo puedes mejorar. 🤝

¡Te espero en la próxima clase! Vamos a estudiar la importancia de escribir específicamente para nuestra audiencia. 💪

Aportes 65

Preguntas 0

Ordenar por:

Los aportes, preguntas y respuestas son vitales para aprender en comunidad. Regístrate o inicia sesión para participar.

Entré en este curso sola para aprender a escribir un buen readme en mis proyectos de GitHub. Pero esta lectura me hizo interesarme mucho por el technical writing.

¡Soy la persona más feliz al saber que existe este curso!
Una de las habilidades más apreciadas en el mundo laboral es saber documentar, habla de sabes trabajar en equipo, de que tienes capacidad abstracción de conceptos e incluso empatía.

Muy bien para su aplicabilidad en proyectos de emprendiiento.

¡Salí buscando cobre y encontré oro!

¿Qué es Technical Writing?

La escritura técnica podemos definirla como el proceso de escribir o documentar ideas, conceptos o procedimientos complejos de forma clara y comprensible en un lenguaje propio del arte, ciencia u oficio por ejemplo para documentar código se utiliza lenguaje propio de la programación.

Objetivo
Transmitir conocimiento técnico de forma comprensible para un público objetivo procurando evitar el error en el uso, operación o procedimiento de cualquier área interesada por ejemplo la utilización de una computadora, un equipo médico etc.
Muy contento con este curso mis sistemas van a mejorar bastante con una documentación de calidad. 😎

Yo sólo quería escribir documentaciones…

Como desarrollador de software estoy interesado en documentar mi código de la mejor manera.

Estoy emocionada por aprender Technical Writing 🤓 💚

Pinta este curso!

Super, justo estaba con estos problemas de escribir documentación. Estaba esperando esta curso gracias!!!

Wow! Después de leerte en otros artículos, ahora aquí en Platzi @Nancynsalazar .

Estaba esperando este curso! 💚💚💚

La verdad también me gusta mucho escribir y hacer documentación, este amor me surgió con los sistemas de diseño (https://platzi.com/clases/sistemas-diseno/) porque era la integración de programas, programación y diseño 💚💚💚

Llevo mis apuntes de cada curso que tomo en Notion 🖤 y ahí hago la documentación de mis proyectos personales, además que quiero crear un blog personal para escribir de tecnología, ciencia y sociedad 🤩

Siento que este curso es algo que me hace falta, recién me estoy adentrando en el mundo de la documentación de código y me gustaría saber cómo hacer documentación más precisa, actualmente hago todo con markdown:3

A empezar una nueva aventura😃.
¡Estoy realmente emocionado! Este es uno de los cursos que necesitaba y no sabía.😧

Esto pinta buenísimo ¡Espero aprovechar este curso al máximo!

El Tecnical Writing se lleva a cabo en cualquier campo donde se necesite explicar ideas, conceptos o procesos complejos. Es mucho más que escribir manuales para software y computadoras.

El technical writing o escritura técnica consiste en traducir ideas complejas a un lenguaje fácil de entender para tus usuarios.

Technical writers are rare hybrids, possessing an uncommon mixture of talents.

<h3>Cómo me convierto en Technical Writer</h3>

Google dice que no hay un camino único para convertirte en technical writer. Para ser un teechnical writing se necesitan las siguientes habilidades:

  • Escribir bien en tu idioma.
  • Escribir bien en inglés.
  • Aprender tecnologías complejas rápidamente.
  • Tener fuertes habilidades interpersonales.
  • Comprender código de programación.

En está página de google encontrarán más información sobre technical writing.

Estoy emocionado por empezar este curso, en una hora empiezo a tomarlo y lo disfrutare al 100% 💚💚💚

🖐 ¿Quién ready para hacer readmes potentes?

creo que este curso puede ayudar a hacer blogs sobre tecnologías también 😄

Una nueva habilidad que me gustaría aprender. Aquí vamos 😄

Escribir la documentacion no es aburrido sino tedioso consejos para optimizar mi trabajo???

Documentar de manera adecuada un proyecto y sus componentes hacen que se pueda dar un mantenimiento más sencillo y una **escalabilidad ** más eficaz en dado caso que se requiera actualizar un software, me emociona mucho encontrar este tipo de artículos.

Es complicado encontrar un flujo de información que te lleve paso a paso a comprender la importancia de estos temas. Muy bien PLATZI por entregar este tipo de contenido a nosotros. Yo lo agradezco bastante.

Uff documentar… hasta el día de hoy no es algo que me agrade pero a veces tenemos que hacer cosas que no nos gustan, espero este curso cambie mi perspectiva y aprenda a hacerlo más fácil y de mejor calidad, soy programador y a veces me cuesta mucho generar manuales de usuario o comentar mi propio código.

Vamos allá 💪

el curso que tanto estaba esperando!!

Me parece súper importante aprender a documentar, ya que sin documentación nuestros proyectos y aplicaciones son difícilmente utilizables para terceras personas.

Tengo que explicar que para mi es muy importante, para generar los documento de capas y componentes y los documentos de macro nivel, los cuales al son, indispensables para que el proyecto pueda ser presupuestado y aprobado.

Tengo que decir que estoy muy interesado en esta clase y tengo la expectativa muy alta en este curso.

Push to start

¡Uf! Me encantó esta descripción ❤️

Justo lo que necesito en estos momento en mi trabajo.

Todo eso que es documentación en lo particular me aburre como dice en el texto, prefiero programar y hacer que los compañeros se encarguen de todo, pero es bueno saber hacerlo, es una de las areas mas importantes dentro de desarrollo de software, espero que en este curso, puede comprender a como llevar a cabo Technical Writer

Me parece muy interesante aprender de esta disciplina ya que muchas veces al momento de investigar y desarrollar un modulo o una aplicacion este tipo de informacion los desarrolladores lo terminan dejando de lado.

Me motiva mucho esta nueva disciplina!

He estado escribiendo regularmente para la web en inglés desde comienzos de 2021.

Estoy muy emocionado por este curso.

En mi trabajo escribo la documentación y me parece algo apasionante. En mi humilde experiencia, las buenas empresas documentan bien sus procesos y de forma clara. Puntualmente los procesos o comportamientos del software son aspectos indispensables de tener escritos en algún lugar para que otros puedan hacer algo más con ellos o simplemente tener una referencia de la cual partir. Obviamente hay que recordar que no todo es o tiene que ser documentable, ¿Qué tal que tuviéramos que documentar hasta los Logs de una app? claramente hay mucho que nos puede ayudar seguir un proceso de documentación técnica, pero hay que conocer cierto límite. Espero que este curso me lleve a conocer esos límites y a aprovechar mucho mejor mi gusto por escribir.

¡Qué interesante! 🤯
📌 Sinceramente yo venía aprender hacer documentación, pero me cautivo lo útil que puede llegar a ser

“¿Cómo me convierto en Technical Writer? ✊”

Soy de México y esa mano significa una grosería, no sé si haya sido a propósito o la hayan puesto sin querer, pero deberían revisarlo.

Genial, vamos a ello

Yo que pensaba que no estaba creando experiencia laboral en mi trabajo, (en el que se suponía que iba a programar) donde sólo me ponen a hacer la documentación de todo y todos. Y aunque me encanta hacerlo, sentía que me estaba quedando en comparación a mis compañeros. Pero qué hermoso saber que hay un nicho dedicado sólo a esto.
Qué emoción comenzar este curso!

Bueno desde hace algún tiempo me sentí interesado en este tema. Ahora entro de cabeza porque justo he visto oportunidades laborales interesantes en esta área. Lo más cercano al técnica writing que he realizado de forma profesional es la redacción de requisitos técnicos para mi y mi equipo de desarrolladores. De forma también profesional pero en el área docente he redactado tutoriales y materiales didácticos.

He querido entrar en este curso porque se me está pidiendo documentar y no sé por donde empezar, también que le he tenido cierta manía a documentar, pero al leer la historia de la profesora, me da ánimos.

Hola
E trabajado en algunos proyectos en la Universidad pero siempre tengo la ligera duda de que si estoy documentando de la mejor manera la aplicacion, espero encontrar algunas respuestas en este curso.

Esto sonó tan sencillo y tan poderoso, vamos a empezar. 😄

Soy QA y espero este curso me ayude a mejorar más mi documentación de código.

Un descubrimiento la verdad, suena muy interesante y entretenido (y útil)…

Estoy muy emocionado por el curso 😄

Vamos iniciando now. let’s go

Una habilidad muy Importante

Python es un lenguaje de programación divertido y extremadamente fácil de usar que en los últimos años se va vuelto muy popular. Este lenguaje pertenece al grupo de lenguajes interpretados dándole oportunidad de ser ejecutado en múltiples plataformas utilizando diversos modelos de desarrollo tales como: programación orientada a objetos, programación imperativa y funcional, está última usada en menor medida. Además de ser un lenguaje multiparadigma hace hincapié en una sintaxis simple.

Me siento emocionada e identificada. Tengo muchas ganas por aprender 😃

Veo que es algo necesario de aprender, asi que vamo a darle

La verdad pocas veces he tenido la oportunidad de documentar un proyecto, pero quiero comenzar a documentar mis pequeños sideprojects, así que vamos a aprovechar este curso :smil

En lo personal estoy empezando a escribir en mi blog personal y creo que este nuevo aprendizaje me vendrá de lujo para continuar escribiendo artículos sobre temas complejos con una mayor calidad 😄

Empezamos esta aventura!
Es interesante el rol de technical writing. En lo personal también me encanta la combinación de la escritura comprensible y la tecnología. Estupendos superpoderes. 🚀

Que rol tan interesante!

Nunca habia escuchado este rol 😮

Iniciando en este submundo tecnológico, Technical Writing allá vamos!!!

A mí me gusta ayudar en la documentación de los proyectos Open Source, y con este curso espero potenciar mis skills para redactar y transmitir mejor. ¡Tengo muchas expectativas!.

Muy interesante se ve el curso no conocia esta rama vamos con toda.

Tengo ya algunos años como redactora publicitaria y siempre he tenido curiosidad de adentrarme a una carrera tecnológica. Al hacer mi investigación encontré la existencia del technical writing y me da mucha curiosidad ver si esta es una opción de carrera para mí.

Una nueva habilidad que me encantara desarrollar. 😎

En estos últimos meses he descubierto lo tanto que me gusta escribir, espero poder fusionarlo también con la tecnología.🤓

¿El manual de usuario del sistema califica como experiencia? 😄😄

Nunca he tenido experiencia formalmente el el Technical Writing pero quiero aprender esta habilidad que creo que es muy util para todos los programadores. 😊

Sí he colaborado en la escritura de la documentación para trabajos escolares, pero creo que aquí aprenderé a hacerlo de una forma más completa y mejor.

Sinceramente no tenia idea que existia toda una rama profesional detras de tantos articulos de tecnologia que he leido en mi vida, me da mucho gusto encontrar un curso completo dedicado ha una de mis pasiones: la lectura.

Interesante!!

Si sabía un poco de qué iba technical writing… No he colaborado escribiendo documentos técnicos (porque me daba flojera, como a tus compañeros 😦 ) y estoy emocionado de aprender a hacerlo bien 😄