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

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

7

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

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

Habilidades para convertirte en Technical Writer

2/20

Lectura

technical-writing1.png

Aportes 24

Preguntas 0

Ordenar por:

¿Quieres ver más aportes, preguntas y respuestas de la comunidad?

Les comparto algunos casos de uso en lo que me a tocado aplicar la Technical Writing para cada área especificada:

  • Información técnica: Puede ser en un manual de usuario donde todos los aspectos que conforman un sistema deben ser redactados de tal forma que el usuario que va a implementarlos tenga una idea clara y precisa de cómo debe de utilizarse.
  • Ideas: En parte inicial del siclo de vida de desarrollo de software nos encontramos con el análisis de requerimientos donde una de las tareas mas importantes en esta etapa es tomar las ideas que el cliente desea y comunicarlas al equipo de diseño y desarrollo de tal forma que sea clara para todas las partes procurando no tener ambigüedades.
  • Conceptos: Esta parte de conceptos podemos encontrarla en la documentación de cualquier tecnología esta documentación esta dirigida a desarrolladores y utilizando como es el concepto de Technical Writing el lenguaje del arte lo que es lo mismo el lenguaje técnico de programación con lo que también podemos ver que se usa el concepto del publico objetivo para el que se escribe.
  • Procesos complejos: Esto se puede encontrar en manuales de procesos donde tenemos documentados todo un procedimiento completo con sus interacciones esto es muy importante ya que nos permite realizar la operación de ciertas actividades de una forma ordenada y establecida ya que existen procesos críticos un ejemplo es el manejo de hidrocarburos donde si no se hace de manera adecuada según el procedimiento documentado podría pasar un accidente fatal que costaría incluso muchas vidas.
    Espero que les ayude a entrar un poco en contexto de cada caso de uso 😀

Si no puedes explicarlo simplemente, es porque no lo entiendes suficiente.
Creo que muchos hemos oído este tipo de frases.

Aqui es donde me doy cuenta que el Ingles es fundamental 😃 animo a todos mis compañeros a aprender Ingles para ser un buen " Technical Writer "

Habilidades de un Techncal Writer

  • Escribir claramente en su idioma natal. 🇪🇸
  • Escribir claramente en inglés. 🇺🇸
  • 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. 💻

La escritura es fundamental y para ello termine la ruta de Periodismo Digital. Me falta aprender Ingles jaja y claro todo el mundo debería saber programar y para hacer Technical Writer con mayor razón.

Tiangolo, el creador del framework FastAPI, el tercer framework de desarrollo web más utilizado de Python, cuenta que dedico mucho más tiempo a la documentación que a la implementación en sí. Esto es un claro ejemplo de la importancia del Technical Writing.

Lo que mas rescato en estas dos primeras clases es la importancia de ayudar a las personas a " ENTENDER" en un lenguaje simple.

No se preocupen si no saben Inglés 🇬🇧. Solo comienzen a escribir “right away”.

Ese encontronazo con no saberte expresar bien, o tener que revisar una y otra vez lo que escribiste es lo que realmente te hace progresar para aprender Technical Writing.

Otro uso importante del technical writing es cuándo vamos a entregar un puesto de trabajo. Para que la persona que venga tenga un mejor onboarding

Listo!

Es muy importante siempre pensar en el público objetivo.

La mayoría de las veces cuando trabajas con muchas personas, tienes que hacer tu trabajo pensando que alguien más lo va a utilizar, entonces, creo que es muy importante tener una documentación bien organizada para que se pueda entender.

Creo que los technical writers no solo se quedan en programación, sino ciencias en general (Matematicas, Fisica, Biologia, Quimica) y pues todas ciencias que derivan de las anteriores que son mas complejas (Astrobiologia, Fisica Cuantica, etc)

Graso error de accesibilidad en esta clase, la imagen no tiene alt textb

Habilidades para convertirte en Technical Writer

Información técnica
Ideas
Conceptos
Procesos complejos

Explicar tecnologías complejas de manera útil para el público objetivo
Fuertes habilidades interpersonales
Escribir claramente en inglés y tu idioma natal
Comprender el código de lenguajes de programación
Aprender tecnologías complejas con relativa rapidez.

Gran introducción 😄.

Lo único que me falta es escribir en inglés técnico y saber explicar las cosas complejas de manera útil para el público objetivo.

Genial

Estoy tomando este curso para un empleo que implica leer y escribir documentación en proyectos de TI, espero y sea el indicado.

Buen resumen. Puedo identificar en que habilidades debo trabajar para poder ser Technical Writer

Y adicionaría nunca parar de aprender

El ingles es fundamental porque es el lenguaje de la industria

Buena infografia 😉

esto es parte de los nuevos empleos del futuro