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

Crea ilustraciones instructivas

19/20

Lectura

El uso de ilustraciones instructivas es una fase fundamental durante la elaboraci贸n de la documentaci贸n t茅cnica. Las ilustraciones ayudan a transmitir a tus lectores informaci贸n compleja de una manera m谩s comprensible y clara. Un caso recurrente que sucede cuando se trata de leer material t茅cnico es que los lectores prefieren ver ilustraciones en lugar de texto. Estas se utilizan para informar, explicar, ilustrar o aprender. Y pueden ser im谩genes, dise帽os, gr谩ficos instructivos, entre otros.

...

Reg铆strate o inicia sesi贸n para leer el resto del contenido.

Aportes 7

Preguntas 0

Ordenar por:

驴Quieres ver m谩s aportes, preguntas y respuestas de la comunidad?

o inicia sesi贸n.

No se me hab铆a ocurrido empezar por escribir el pie de pagina y despu茅s la imagen, considero que ser谩 muy practico.
Tambi茅n generar im谩genes sin mucha complejidad, poniendo solo lo m铆nimo necesario para que sean entendibles.

Aunque parezca incre铆ble, yo prefiero la primera imagen del metro sobre la segunda jajaja, pero en mi caso usar铆a un tono de gris m谩s claro para las avenidas 馃槃

Otra herramienta gratuita para hacer diagramas:

para quienes estamos interesados en documentar gr谩ficos en Data Analytics, es recomendable tomar este curso en Platzi

Se parece mucho al sistema de Trasnmilenio de Bogot谩

jajaja por un momento pens茅 que era el sistema de Transmilenio de Bogot谩 馃槄