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

C贸mo organizar documentos largos

18/20

Lectura

驴C贸mo se organiza una gran colecci贸n de informaci贸n en un documento o en un sitio web de manera coherente? 驴C贸mo se reorganiza un documento o sitio web desordenado en algo accesible y 煤til? Son preguntas a las que te enfrentar谩s una vez que comiences a desarrollar documentos t茅cnicos largos. Pero no todo est谩 perdido, los siguientes procedimientos pueden ayudarte:

...

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

Aportes 4

Preguntas 1

Ordenar por:

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

o inicia sesi贸n.

En el Curso de Arquitectura de la Informaci贸n con Usaria estudiamos m谩s a fondo todo sobre los flujos y buenas pr谩cticas de navegaci贸n en general. 馃憪

Para la navegaci贸n me gusta Notion 馃枻 ya que puedo crear una lista de contenidos, as铆 miro los encabezados y al dar click al que me interesa voy directamente. Y todo sin tener que crear los links cada uno a mano.

Yo soy programador y me gusta usar Visual Studio Code para tomar notas ya que puedo ordenar el texto sin necesidad de copiar o pegar. Y al mismo tiempo ver el producto finale que voy escribiendo con la estructura de Markdow.

Es m谩s probable que los lectores sean receptivos a documentos m谩s largos que les revelen paulatinamente nueva informaci贸n cuando la necesiten.

Mmm, yo personalmente noto que los libros que son 茅xito de ventas suelen tener cap铆tulos cortos. Esto puede traducirse en que se puede retener mejor al lector si se tienen algunos documentos peque帽os para que el lector sienta que est谩 鈥渃ompletando鈥 una lectura mientras m谩s lee, que si tiene uno largo que debe ser le铆do de punta a punta para que el lector pueda considerar una lectura como 鈥渃ompletada鈥.