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.
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'.
adj. Perteneciente o relativo a las aplicaciones de las ciencias y las artes.
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.
f. Conjunto de procedimientos y recursos de los que se sirve una ciencia o un arte.
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. 💪
Juan Guillen Fortich
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.
Jose Luis Bedoya
rt
David Aguilera
Si lo que quieres es un buen Readme. Te recomiendo estos enlaces...
Espero que te sirva alguno, saludos ✌️
María Sierra
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.
Cómo me convierto en Technical Writer
Google dice que no hay un camino único para convertirte en technical writer. Para ser un teechnical writing se necesitan las siguientes habilidades:
En está página de google encontrarán más información sobre technical writing.
Omar Sánchez
Muy bien para su aplicabilidad en proyectos de emprendiiento.
Juan Esteban Galvis
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 🤩
Juan Castro
ProfesorEl Curso de Sistemas de Diseño es de los que más he amado en Platzi. :green_heart:
Jorge Olvera Martínez
¡Salí buscando cobre y encontré oro!
María Fernanda Magallanes Z
:raised_hand_with_fingers_splayed: ¿Quién ready para hacer readmes potentes?
Daniel Cueto
Yo sólo quería escribir documentaciones...
Juan Castro
Profesor¡Podrás hacer muchísimo más! ¡Sin miedo al éxito!
Juan Carlos García Esquivel
¿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. 😎
Dilan Santiago Ariza Cañon
Estoy emocionado por empezar este curso, en una hora empiezo a tomarlo y lo disfrutare al 100% 💚💚💚
Esteban Josué Alvarado Vargas
Esto pinta buenísimo ¡Espero aprovechar este curso al máximo!
Milton Josué Barrera Zepeda
A empezar una nueva aventura😃. ¡Estoy realmente emocionado! Este es uno de los cursos que necesitaba y no sabía.😧
Jimmy Buriticá Londoño
Como desarrollador de software estoy interesado en documentar mi código de la mejor manera.
Karla
Estoy emocionada por aprender Technical Writing 🤓 💚
Francisco Enrique Giménez Vera
Pinta este curso!
Alberth Michael Apaza Apaza
Super, justo estaba con estos problemas de escribir documentación. Estaba esperando esta curso gracias!!!!
Ximena Cruz
Wow! Después de leerte en otros artículos, ahora aquí en Platzi @Nancynsalazar .
Jorge Enrique Pérez Escobar
Automáticamente yo al ver este curso.
Genial curso la verdad solo con esta introducción ya me engancho.
Carlos Eduardo Gomez García
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
Abdias Jimenez
a que ruta de aprendizaje corresponde este curso?
Samuel Soto Hoyos
Hola Abdias Jimenez, este curso pertenece a la escuelaTechnical Writing
