Divide y vencerás
Introducción al Technical Writing
¿Qué es Technical Writing? Lleva tu documentación al siguiente nivel
Habilidades para convertirte en Technical Writer
¿Conoces a tu público? Escribe específicamente para tu audiencia
Cómo entrevistar equipos de programación para recolectar información técnica
Estructura gramatical
Un repaso por la gramática básica
Uso correcto de acrónimos y abreviaturas para explicar términos desconocidos
Voz activa vs. voz pasiva: estándares y estructura de una oración
Técnicas de escritura fundamentales para documentos técnicos
Sigue las reglas de George Orwell para escribir con claridad
Uso correcto de listas y tablas para ordenar información
Tipos de párrafos y paso a paso para estructurarlos
Conceptos básicos de programación e ingeniería de software
¿Qué es programación? Evolución de la documentación y technical writing
Lenguajes de programación, tipos de datos y estructura de documentos HTML
Estándares de documentación de código
Cómo documentar una función de código
Buenas prácticas de legibilidad para código y comentarios
Organización y revisión de tu documentación
Organiza y define el alcance de tus documentos
Utiliza Markdown en documentos técnicos
Guía para revisar documentación en equipo de manera efectiva
Cómo organizar documentos largos
Diseño de documentos
Crea ilustraciones instructivas
Conclusiones
Siguientes pasos para convertirte en Technical Writer profesional
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.
...
Regístrate o inicia sesión para leer el resto del contenido.
Aportes 22
Preguntas 1
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.
¿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.
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.
Un buen texto es la expresión de las ideas de manera clara y ordenada
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:
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 “ideas claras”
Vine Vidi Vici
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: “si 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 ‘sujeto * 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.
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.
¿Quieres ver más aportes, preguntas y respuestas de la comunidad?