Introducción al Technical Writing

1

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

2

Habilidades para convertirte en Technical Writer

3

¿Conoces a tu público? Escribe específicamente para tu audiencia

4

Cómo entrevistar equipos de programación para recolectar información técnica

Estructura gramatical

5

Un repaso por la gramática básica

6

Voz activa vs. voz pasiva: estándares y estructura de una oración

7

Uso correcto de acrónimos y abreviaturas para explicar términos desconocidos

Técnicas de escritura fundamentales para documentos técnicos

8

Sigue las reglas de George Orwell para escribir con claridad

9

Uso correcto de listas y tablas para ordenar información

10

Tipos de párrafos y paso a paso para estructurarlos

Conceptos básicos de programación e ingeniería de software

11

¿Qué es programación? Evolución de la documentación y technical writing

12

Lenguajes de programación, tipos de datos y estructura de documentos HTML

Estándares de documentación de código

13

Cómo documentar una función de código

14

Buenas prácticas de legibilidad para código y comentarios

Organización y revisión de tu documentación

15

Organiza y define el alcance de tus documentos

16

Utiliza Markdown en documentos técnicos

17

Guía para revisar documentación en equipo de manera efectiva

18

Cómo organizar documentos largos

Diseño de documentos

19

Crea ilustraciones instructivas

Conclusiones

20

Siguientes pasos para convertirte en Technical Writer profesional

Siguientes pasos para convertirte en Technical Writer profesional

20/20

Lectura

Hemos llegado al final del Curso de Introducción al Technical Writing y Documentación de Código. Me da mucho gusto que hayas llegado hasta aquí. Puedes estar segura de que todo lo que hemos aprendido será impresionantemente útil para tu presente y futuro profesional.

Recuerda lo que dice Google acerca de que los technical writers: somos híbridos raros que poseemos una mezcla poco común de talentos. ¿Qué esperas para explotar todo tu talento y aplicar lo aprendido en tu día a día? ¡Sorprende al mundo con tus habilidades!

🤓 Hasta este punto debes tener muy claros los siguientes puntos:

  • Technical Writing va mucho más allá de la creación de manuales para software y computadoras. Nuestro objetivo es transformar la información técnica en un lenguaje fácilmente comprensible para tu audiencia.
  • Sabes identificar a la audiencia para la cual van dirigidos los documentos técnicos que realices.
  • Conoces herramientas y recomendaciones a considerar cuando recopilas información para tus documentos técnicos.
  • Puedes aplicar los conceptos de gramática básica en tus escritos.
  • Aprendiste a usar términos adecuados al definir terminología desconocida.
  • Escribes tu documentación de una manera corta, correcta, efectiva y principalmente con claridad.
  • Conviertes los textos en prosa a listas y/o tablas con información útil para el lector.
  • Estructuras párrafos claros y precisos para dar definiciones, explicar un proceso o presentar argumentos.
  • Repasaste o diste un primer vistazo a los conceptos básicos de la programación: los tipos de datos más comunes, qué es HTML y JavaScript, cómo trabajar con variables, constantes, case-sensitive, entre otros.
  • Sabes documentar bloques de código para explicar la tarea que realizan, qué parámetros reciben y qué valor van a retornar.
  • Sigues las características esenciales para documentar código de muestra: el código debe ser correcto, conciso, comprensible, comentado, reutilizable y secuenciado.
  • Aprendiste a organizar documentos de una manera coherente a través de esquemas, escribiendo introducciones enganchadoras, añadiendo navegación en tu documento y revelando información paulatinamente.
  • Sabes cómo crear ilustraciones simples, instructivas, legibles a la vista, teniendo en cuenta el pie de imagen y usando señales visuales para que tu lector logre comprender nuestro contenido.

💚 ¡Qué genial que domines todas estas habilidades! Recuerda que tu camino no termina aquí. Nunca parar de aprender es esencial para trabajar en el mundo digital. Y es por esto que te recomiendo continuar tu carrera profesional como technical writer tomando los siguientes cursos (en el orden que prefieras):

⭐️ ¿Cuál tomarás primero?


💪 ¡Demuestra todo lo que has aprendido completando el examen! No olvides calificar el curso con 5 estrellitas y contarnos en los comentarios de esta clase si te emociona aprender aún más sobre technical writing.

¿Qué temas te gustaría encontrar en un próximo curso? Recuerda que esto apenas fue la introducción. Si quieres profundizar más, let me know! Estoy encantadísima de seguir compartiendo contigo para convertirte en una technical writer excepcional. 😉

¡Nos leemos en el futuro!

Aportes 17

Preguntas 0

Ordenar por:

¿Quieres ver más aportes, preguntas y respuestas de la comunidad? Crea una cuenta o inicia sesión.

Me encanto el curso 💚💚💚

Espero con ansias un curso de Notion 🖤 además me gustaría que hicierán más cursos sobre technical writing! la documentación me parece muy importate y así como el diseño es crear obras de arte, a nuestra manera claro jaja

Me gusto mucho el curso y ya que tengo los conocimientos en programación me enfocaré en aprender más de SEO, Ingles y Marketing

¿Cómo no había llegado este curso antes? ¡Es espectacular! No solo esta redactado para documentar algo exclusivamente técnico. Parte de algo sencillo para explicar algo técnico y termina siendo algo sencillo… La buena energía se contagia ¡Gracias por mostrarnos un camino diferente! 💚

A medida que iba recorriendo el curso pensaba “esto es un muy buen complemento al curso que hice de Copywrinting para Plataformas Digitales”, y fíjate, lo recomienda al final.
Perfecto!!

Este formato de curso compuesto por solo lecturas ha sido muy interesante, rompe la monotonía de los vídeos, como los cursos que son solo de audio.

Deberían seguir haciendo cursos de esta forma, y ¡esperamos ver a Nancy en otro curso! Muchas gracias 😃

La información es muy interesante, me quedo con la frase: “el tú del futuro agradecerá la documentación que haga tu tú del presente”.

<h1>Como voy a utilizar lo aprendido en este curso</h1>
  • documentar codigo
  • escribir articulos
  • usar MarkDown en lugar de word o writer
  • Hacer feliz a quien lea mis escritos

Me gusto bastante este curso incluso no sabia que existía los technical writer. Por ahora creo que es super bueno manejar ortografía e ingles técnico.
Muchas gracias por compartir estas experiencias.

De los cursos que mencionas los que más me hacen falta ahorita son el de inglés y el de buenas prácticas de escritura de código. 🙌 🎉

No tienes ni idea de lo mucho que me alegra saber que no soy la única híbrida rara 😆
Me encantó el curso Nancy, gracias ❤️ Muy útil e inspirador.

Primer curso de Platzi que veo que no tiene videos en sus clases 🎥. Al principio pensé que no me iba a gustar (uno se mal acostumbra 😅) pero en este caso me llamó mucho la atención y terminé el curso ❤️ 📜

Estaría genial un curso que profundizara más en Technical Writing y todas sus aristas, porque seguro hay varias personas que, como yo, nos decantamos por este camino. ¡Todo el material estuvo excelente, muchas gracias, Nancy!

Me gustó la lógica del curso. Un curso de cómo escribir para comunicar bien, está escrito y comunicado bien. Me gustó el curso.

Usare estos nuevos conocimientos para documentar de mejor forma mi código fuente. Gracias Nancy.

Me encantó el curso, estaría muy feliz si crearán la escuela de Technical Writing

Los conocimientos que ha transmitido la profesional en el área han sido geniales, muchas gracias por ayudarme a aprender y poco a poco convertirme en Technical Writer!

El tutortial de markdown y cómo documentar en javascript me llevo de este curso 😄

Gracias por el curso y las aportaciones que hicieron mis compañeros, será de gran utilidad no solo para redactar mi trabajo correctamente, abre el panorama a aplicación en mi escuela, trabajos personales y enseñar lo aprendido a mis colegas.

Hola Comunidad! Antes tenia en VC una extensión que me cambiaba de color los “@param, @return, etc…” y adicional si escribía “@” me sacaba una lista con las posibles opciones pero formatee el computador y perdí esta extensión ¿alguien sabe como se llama o tiene una de utilidad?