Technical Writing Profesional
Acerca de este curso
El technical writing o escritura técnica consiste en traducir ideas complejas a un lenguaje fácil de entender para tus usuarios. Aunque casi siempre lo relacionamos con la documentación de código y manuales de software, el trabajo tiene muchísimas otras aplicaciones, como enseñar a manejar programas informáticos, operar equipos industriales o incluso evaluar condiciones médicas. Saber escribir documentos técnicos es una gran habilidad para tu perfil profesional. Como technical writer debes adentrarte en un flujo de trabajo muy completo y podrás ver el éxito de tus usuarios gracias a la gran comunicación y empatía que tuviste con ellos. Este curso está alineado a los estándares oficiales recomendados por Google para ejercer buenas prácticas de Technical Writing.Descripción
> Módulo 1. Gramática necesaria
Sustantivos
Pronombres
Verbos
Adjetivos y adverbios
Preposiciones
Conjunciones y transiciones
> Módulo 2. Palabras
Definir términos nuevos o desconocidos
Utilice el acrónimo correctamente
Pronombres desambiguados
> Módulo 3. Voz activa
Distinguir la voz activa de la pasiva en oraciones simples
Reconocer verbos pasivos
Distinguir la voz activa de la pasiva en oraciones más complejas
Prefiere la voz activa a la pasiva
> Módulo 4. Oraciones claras
Elige verbos fuertes
Reducir
Minimizar ciertos adjetivos y adverbios
> Módulo 5. Oraciones breves
Enfocar cada oración en una sola idea.
Convierte algunas oraciones largas en listas
Eliminar o reducir palabras extrañas
Reducir las cláusulas subordinadas
Distinguir
> Módulo 6. Listas y tablas
Elija el tipo correcto de lista
Mantenga los elementos de la lista en paralelo
Comience los elementos de la lista numerada con verbos imperativos
Puntúe los elementos de forma adecuada
Crea tablas útiles
Presente cada lista y tabla
> Módulo 7. Párrafos
Escribe una gran oración de apertura.
Enfoca cada párrafo en un solo tema.
No hagas párrafos demasiado largos ni demasiado cortos
Responde qué, por qué y cómo
> Módulo 8. Público
Define tu audiencia
Determina lo que tu audiencia necesita aprender
Adapte la documentación a su audiencia
> Módulo 9. Documentación
Indique el alcance de su documento
Indique su audiencia
Establezca sus puntos clave por adelantado
Escribe para tu audiencia
Divide tu tema en secciones
> Módulo 10. Puntuación
Comas
Punto y coma
“Em-Dashes” en lenguajes de programación
> Módulo 11. Markdown
> Módulo 12. Autoedición
Adopte una guía de estilo
Piensa como tu audiencia
Léelo en voz alta
Vuelve a eso más tarde
Cambiar el contexto
Encuentra un editor personal
> Módulo 13. Organización de documentos grandes
Cuándo escribir documentos grandes
Organizar un documento
Agregar navegación
Divulgar información de forma progresiva
Módulo 14. ilustración y diagramas
Escribe la leyenda primero
Restrinja la cantidad de información en un solo diagrama
Centrar la atención del lector
Ilustrar es re-ilustrar
Herramientas de ilustración y diagramación
Módulo 15. Creación de código de muestra
Correcto
Conciso
Comprensible
Comentado
Reutilizable
El ejemplo y el anti-ejemplo
Secuenciado
¿Qué aprenderé?
- Conocimientos y habilidades necesarias para realizar Technical Writing profesional, alineado a los estándares y best practices de hoy.