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

Reg谩late acceso ilimitado a todos los cursos por 1 a帽o a precio especial de Navidad 馃巹

Antes: $199

Currency
$149/a帽o
reg铆strate

termina en:

16D
1H
52M
5S

Habilidades para convertirte en Technical Writer

2/20

Lectura

technical-writing1.png

Aportes 23

Preguntas 0

Ordenar por:

Los aportes, preguntas y respuestas son vitales para aprender en comunidad. Reg铆strate o inicia sesi贸n para participar.

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.

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

Listo!

No se preocupen si no saben Ingl茅s 馃嚞馃嚙. Solo comienzen a escribir 鈥渞ight 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.

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.

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

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)

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