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

Sigue las reglas de George Orwell para escribir con claridad

8/20

Lectura

En el technical writing la claridad es primordial por encima de todo. Es un tema indiscutible. Y para ello las frases son la unidad mínima en las que podemos expresar una idea. Tus frases deben ser claras y efectivas, así tus textos se entenderán mejor, el lector captará el mensaje fácilmente y tú harás gimnasia mental para ordenar tus pensamientos. Recuerda que a veces escribimos mal porque pensamos mal.

...

Regístrate o inicia sesión para leer el resto del contenido.

Aportes 20

Preguntas 0

Ordenar por:

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

Las reglas de George Orwell me recordaron al “Zen de Python”:

The Zen of Python
    Beautiful is better than ugly.
    Explicit is better than implicit.
    Simple is better than complex.
    Complex is better than complicated.
    Flat is better than nested.
    Sparse is better than dense.
    Readability counts.
    Special cases aren't special enough to break the rules.
    Although practicality beats purity.
    Errors should never pass silently.
    Unless explicitly silenced.
    In the face of ambiguity, refuse the temptation to guess.
    There should be one-- and preferably only one --obvious way to do it.
    Although that way may not be obvious at first unless you're Dutch.
    Now is better than never.
    Although never is often better than *right* now.
    If the implementation is hard to explain, it's a bad idea.
    If the implementation is easy to explain, it may be a good idea.
    Namespaces are one honking great idea -- let's do more of those!

En el Curso de Escritura Online podemos profundizar muchísimo más en las buenas prácticas de redacción y escritura para internet. :run:

¡Pensaría que estas oraciones se pueden reducir aún más!

A pesar de que Gerardo no sabe programar, él sabe documentar software.
Aunque Gerardo no sabe programar, él sabe documentar software.


Quedaría mejor (en mi opinión):

Gerardo no sabe programar, pero sabe documentar software.

O si el contraste entre lo que sabe y no sabe no es importante para el caso, podría quedar:

Gerardo no sabe programar, sabe documentar software.

¡Saludos! 😄

¿Cómo sabes si un verbo es fuerte o débil?

📌 Súper importante:
.
Tus frases deben ser claras y efectivas, así tus textos se entenderán mejor, el lector captará el mensaje fácilmente y tú harás gimnasia mental para ordenar tus pensamientos. Recuerda que a veces escribimos mal porque pensamos mal.

Lo que yo hago cuando no sé ordenar las ideas es ir escribiendo lo que me salga de la mente. Luego lo leo y veo qué ideas se pueden integrar en otra misma o definitivamente arreglarlas, por ejemplo:

Para empezar qué es la ansiedad y cuáles son los síntomas.
Pasa que durante la adolescencia incrementa, más que nada he notado que entre los 16 y cuando vamos a cumplir 18, la ansiedad.

**Empezamos a crear dudas existenciales, pero más que nada, pensamos que ya al ser mayores, nuestra vida se acaba.

Otra parte, es que al ir habiendo cambios, empezamos a deprimirnos, ansiedad, dudas existenciales, ya que antes no teníamos tal vez la percepción de la realidad que ahora, evidentemente, nos vamos convirtiendo en adultos y vemos una vida llena de obstáculos.**

Y queda así:

Introducción, qué es la ansiedad y síntomas.
Pasa que durante la adolescencia incrementa, más que nada he notado que entre los 16 y cuando vamos a cumplir 18, la ansiedad.
Otra parte, es que al ir habiendo cambios, empezamos a deprimirnos, ansiedad, dudas existenciales, ya que antes no teníamos tal vez la percepción de la realidad que ahora, evidentemente, nos vamos convirtiendo en adultos y vemos una vida llena de obstáculos y por ende, pensamos que nuestra vida acaba ahí, en los 18.

Esto me ayuda mucho para que no se me olvide y para mejorar su comprensión.

Me llamo poderosamente la atención.

Nunca uses una palabra larga cuando una corta funciona.
Si es posible recortar una palabra, hazlo.
Nunca uses la voz pasiva, usa la voz activa en su lugar.
Nunca uses una frase extranjera, una palabra científica o de la jerga si puedes pensar en un equivalente del inglés -o el idioma en el que redactes tu documento- cotidiano.

in oder words...K.S.S (keep it short and simple) bb

Muy interesante.

Me gustaría precisar que en el apartado de palabras superfluas, una cosa es la concisión y otra es usar palabras superfluas. El caso de “Aunque…” en vez de “A pesar de que…” es preferir frases cortas por la velocidad de lectura. En constraste, palabras superfluas serían “Baja el menu hacia abajo” o “Yo mismo tuve que programarlo”. Usar palabras superfluas se suele considerar un vicio de lenguaje.

Esto tiene su excepción: el uso intencionado del énfasis. “Yo mismo tuve que programarlo” tiene diferente significado si lo escribe el gerente de TI de una gran empresa que si lo escribe un technical writer.

Asimismo, si como redactor técnico tienes que trabajar con abogados (por ejemplo, para temas legales de informática), deberás acostumbrarte a leer documentos y materiales con escritura compleja. Algo similar pasa cuando se trabaja con académicos. De ahí se desprende que tienes que ser capaz de leer y entender textos complejos.

Estas son algunas sutilezas del lenguaje que es necesario conocer para mejorar nuestros skills como technical writers.

Otro aporte es que veo muchas similitudes con la redacción periodística. Algunos de sus principios son:

  • Claridad: Escribir para que lo entiendan todos.
  • Concisión: Usar solo las palabras indespensables, justas y significativas.
  • Densidad: Cada frase tiene sentido en el texto, o una idea por frase.
  • Exactitud: Evitar las palabras amplias de significado.
  • Precisión: No divagar, ir directo a los hechos con rigurosidad.
  • Sencillez: Palabras de uso común. Lo contrario es lo artificioso.
  • Brevedad: No escribir más allá de lo indespensable y necesario.
  • Variedad: Evitar la monotomía. No repetir palabras frecuentemente.
  • Ritmo: En este caso, no usar un ritmo lírico ni filosófico.
  • Corrección: El lenguaje debe ser correcto desde el punto de vista gramatical.

Me parece que si tantas personas tienen problemas en ser cortos y concisos a la hora de escribir creo que en gran parte es culpa de la escuela y la educación tradicional.
Por situaciones como “redactar informe de tema [tema] de mínimo 4 paginas” cuando debería priorizarse la calidad del contenido en vez de la extension del mismo.

Faltaron dos reglas de Orwell en caso de que a alguien le interese:

  • Nunca uses una metáfora, símil u otra figura retórica que estás acostumbrado a ver impresa.

  • Rompe cualquiera de estas reglas antes de que te hagan decir una auténtica barbaridad

La escritura con buena otorgrafía también establece la preparación ante el tema a desarrollar.

También hay que recordar que por etiqueta de escritura, es necesario considerar que no todas las personas tienen el conocimiento necesario para entender la visón del tema técnico que se este explicando de manera escrita.

Por lo tanto es necesario utilizar un lenguaje simple para que el público que lea nuestro escrito pueda entenderlo y llevarlo a la práctica en su día a día.

“Te escribo una carta larga porque no tengo tiempo de escribir una corta”.

Una genialidad la frase de Blaise Pascal.

La frase matadora:

Recuerda que a veces escribimos mal porque pensamos mal.

Escribimos mal porque pensamos mal.

Alguien mas siente que los emojis que colocan en los títulos ayuda a “descansar” un poco?

Excelente, gracias

Muy buen capitulo 😃

Excelentes puntos.

Las palabras largas son más difíciles de entender por parte de nuestro cerebro.