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

Voz activa vs. voz pasiva: est谩ndares y estructura de una oraci贸n

7

Uso correcto de acr贸nimos y abreviaturas para explicar t茅rminos desconocidos

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

Tipos de p谩rrafos y paso a paso para estructurarlos

10/20

Lectura

Los p谩rrafos son la base de los documentos que redactamos como technical writers. En p谩rrafos claros y precisos damos definiciones, explicamos un proceso o presentamos argumentos.

En la clase sobre c贸mo escribir con claridad nos qued贸 claro que una frase es la unidad m铆nima en la que se puede expresar una idea. En este cap铆tulo descubriremos que los p谩rrafos son la unidad m铆nima en la que se puede desarrollar una idea.

驴Qu茅 es un p谩rrafo? 馃懆鈥嶐煉

Un p谩rrafo es la m铆nima unidad de redacci贸n que explica y desarrolla el significado de una idea. Los p谩rrafos generalmente tienen tres partes: la oraci贸n principal, las oraciones argumentativas y la oraci贸n final; todas ellas contienen la misma palabra o idea clave que controla la informaci贸n en el resto del p谩rrafo.

La oraci贸n principal tiene que ser una gran frase inicial. Hoy en d铆a la mayor铆a de las personas est谩n ocupadas y leen r谩pidamente centr谩ndose en las frases iniciales, por lo tanto, invierte tu energ铆a en grandes frases iniciales, estas son las que establecer谩n el punto central a tus p谩rrafos.

Escribe la introducci贸n de tu texto | Curso de Escritura Online en Platzi

Detalles a considerar en el prop贸sito de tu p谩rrafo 馃

Para escribir p谩rrafos efectivos debes tener en cuenta que los detalles espec铆ficos coincidan con el prop贸sito de tu p谩rrafo. En esta tabla te lo explico:

technical-writing3.png

Paso a paso para escribir un p谩rrafo 馃攽

Para terminar te compartir茅 paso a paso c贸mo comenzar谩s a estructurar cada uno de tus p谩rrafos:

technical-writing4.png

Antes de cerrar este cap铆tulo, te dejo esta frase para que contin煤es con mayor motivaci贸n:

El trabajo de escribir es simplemente esto: desenredar las dependencias entre las partes de un tema y presentar esas partes en un flujo l贸gico que permita al lector entenderlo.

驴Lo entendiste? 隆Cu茅ntame en los comentarios! Ahora estamos listos para conocer los conceptos b谩sicos de programaci贸n.

Aportes 20

Preguntas 0

Ordenar por:

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

Divide y vencer谩s

馃搶 La oraci贸n que m谩s me llam贸 la atenci贸n:
.
Hoy en d铆a la mayor铆a de las personas est谩n ocupadas y leen r谩pidamente centr谩ndose en las frases iniciales, por lo tanto, invierte tu energ铆a en grandes frases iniciales, estas son las que establecer谩n el punto central a tus p谩rrafos.

Si, lo entendi.
Busca separar las ideas expuesta y lo ordena con palabras cotidianas para que sea entendido por personas.

Esta es la base de toda la escritura y lo que diferencia de un buen texto a uno malo. La forma en que estructuramos nuestros p谩rrafos define si nuestro lector quedara satisfecho o se saldr谩 a media lectura porque perdi贸 el inter茅s.

La escritura es un superpoder. Excelentes pasos para escribir un parrafo, en otras palabras es NO escribir largo, escribe interesante. Algo que puedo sugerir es agregar titulos cortos, explosivos y concretos, as铆 como acompa帽ar de imagenes el texto.

El trabajo de escribir es simplemente esto: desenredar las dependencias entre las partes de un tema y presentar esas partes en un flujo l贸gico que permita al lector entenderlo.
Yo lo entiendo de la siguiente manera:

  • Ordena las ideas
  • Enfatiza lo importante
  • Clarifica el flujo de un proceso

驴Alguien sabe porque al definir el p谩rrafo no utilizo una lista? Como se explico en el anterior capitulo la informaci贸n seria mucho mas clara si la hubiera puesto como lista.
El p谩rrafo es la unidad m铆nima de redacci贸n que explica y desarrolla el significado de una identidada. Los p谩rrafos generalmente tienen tres partes:
1 La oraci贸n principal.
2 Oraciones argumentativas
3 Oraci贸n final.
Todas ellas tienen la misma palabra o idea clave que controlan la informaci贸n en el resto del p谩rrafo

驴Creen que sea hecho a prop贸sito por alg煤n motivo que yo no entend铆?

Saludos.

Entendido, claros y consisos, una idea se trasmite mejor, una estrateg铆a que insita a ser efectuada, un .README de facil interpretaci贸n, y podr铆a llegar ha comprenderme mejor usando las palabras adecuadas!! 馃挌馃惏

Entendido y anotado, resalto 鈥渋deas claras鈥

Aqu铆 es cuando entra en juego el copywriting en donde la idea es hacer que el lector no canse su vista, se recomienda utilizar parrafos grandes cuando se necesite describir o desarrollar un concepto mientras que para las introducciones se busca una frase corta pero que de pie a llamar la atenci贸n para que llegue el mensaje y siga leyendo.

Entiendo que el trabajo de escribir es poder enfocar todo lo que tu mente tiene en un sentido claro para cualquier persona, poder tener ideas, plasmarlas en una hoja y que las personas a tu alrededor entiendan tus puntos no es f谩cil, por eso es importante la forma de expresar, ahorra tiempo y enfoca a un grupo a un mismo objetivo.

隆Gracias!
Tan clara como el agua.
Continuemos鈥

Cuando estudi茅 Letras Hisp谩nicas todos trat谩bamos de ser muy extensos y rebuscados en nuestros textos, pero mi mentalidad cambi贸 cuando una Profesora de Espa帽ol nos dijo: 鈥渟i quieren impresionarse entre ustedes, sigan escribiendo como lo hacen. Si quieren que los dem谩s los lean (que son muchas m谩s personas de las que ustedes son), sean simples. Basta con seguir la regla 鈥榮ujeto * verbo + complemento鈥 y p谩rrafos breves y ordenados. No necesitan m谩s.鈥

De repente a煤n me cacho siendo redundante y complicada, pero nada que borrar y volver a escribir no solucione.

Un buen texto es la expresi贸n de las ideas de manera clara y ordenada

Que interesante y fascinante es la escritura, y lo retador que puede ser escribir de manera entendible y precisa, para expresar nuestras ideas.

Ser un Technical Writing es una ayuda para las personas que no son nativas del internet y estamos nosotros para ayudarles en la transici贸n hacia la misma, es una gran responsabilidad.

Dar orden y limpieza a las ideas

Entend铆 que es identificar claramente los componentes de un tema, atomizarlos (independizarlos lo m谩s que se pueda) para luego vincularlos y presentarlos de forma l贸gica y ordenada.

En un p谩rrafo expresamos una idea o concepto.

Ordenar las ideas para que los dem谩s las entiendan.