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 8

Preguntas 0

Ordenar por:

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

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 😄

hHel pie de pagina cumple la misma funcion que el alt text? o el alt text debe ser mas descriptibo?, que tips puedo usar para hacer mis alt text o el pie de imagen mas descriptivos.o

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á 😅