Dominio del Technical Writing y Documentación de Código

Clase 20 de 20Curso de Introducción al Technical Writing y Documentación de Código

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):

:star: ¿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!