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

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

Contenido del curso

Introducción al Technical Writing

Estructura gramatical

Técnicas de escritura fundamentales para documentos técnicos

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

Estándares de documentación de código

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

Diseño de documentos

19
Técnicas para Crear Ilustraciones Instructivas Efectivas
02:53 min

Conclusiones

20
Dominio del Technical Writing y Documentación de Código
Viendo ahora

Tomar examen

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

Curso de Estrategias para Aprender en Línea Efectivamente: entiende cómo funciona nuestro cerebro y aprovéchalo para mejorar tus técnicas de estudio y enseñanza profesional.
Curso de Ortografía Básica: la mala ortografía es tu mal aliento en internet. Y como escritora técnica estás encargada de dar la cara por empresas, marcas y proyectos, así que es mil veces más importante prepararte correctamente. En el curso conocerás técnicas importantes para mejorar tu ortografía, gramática y redacción.
Curso de Escritura Online: escribir por escribir no es suficiente. Tus textos deben cautivar a la audiencia. Con este curso aprenderás a crear un hábito de escritura siguiendo las mejores prácticas de industria. Conocerás las estrategias para realizar un proceso de planeación, investigación y revisión exitoso.
Curso de Introducción al Marketing Digital.
Curso de Introducción a SEO: Posicionamiento en Buscadores: usando datos estructurados y optimizando tu contenido web puedes mejorar tu posición en los resultados de motores de búsqueda como Google para aumentar tu tráfico y ventas online.
Curso de Content Marketing.
Curso de Storytelling: los números por sí solos no son muy llamativos. Es gracias a las historias que podemos conectar emocionalmente con nuestros lectores u oyentes. Con este curso descubrirás las técnicas y estructura que siguen las buenas historias para atrapar a tu audiencia.
Curso de Copywriting para Plataformas Digitales.
Curso de Copywriting con Técnicas de Storytelling.
Curso de Estrategias para Aprender Inglés Online: examina tu nivel de inglés, descubre herramientas en línea para fortalecer tus competencias (speaking, writing, reading, listening) y crea un plan de aprendizaje para cumplir el objetivo que te impulsa a aprender inglés.
Curso de Inglés Técnico para Profesionales.
Curso de Escritura en Inglés.
Curso Básico de JavaScript: domina los conceptos esenciales de programación en JavaScript y empieza tu camino para convertirte en una desarrolladora web profesional.
Curso de Buenas Prácticas para Escritura de Código.
Curso de Creación de Portafolio y CV: enamora a tus futuros jefes y clientes creando tu propio portafolio profesional con las mejores prácticas para hacer brillar tus proyectos y experiencia laboral.

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

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