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

Aprende Inglés, Programación, AI, Ciberseguridad y más a precio especial.

Antes: $249

Currency
$209
Suscríbete

Termina en:

2 Días
3 Hrs
43 Min
29 Seg

Voz activa vs. voz pasiva: estándares y estructura de una oración

7/20

Lectura

La voz verbal es todo un fenómeno. Sirve para marcar la relación que tiene el sujeto con el verbo. El verbo tiene dos voces: voz activa y voz pasiva. Aunque en español es un poco difícil de comprender, la usamos de manera inconsciente en nuestro día a día, así que quizás ahora que leas este capítulo prestes atención a la estructura que das a tus oraciones, ya sea al hablar o escribir.

...

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

Aportes 89

Preguntas 1

Ordenar por:

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

  • Los archivos del directorio values/ describen varios recursos.
  • Cada campo secundario del elemento define un único recurso.
  • Los subdirectorios definidos guardan tus recursos predeterminados.
  • (Pasiva) Varios recursos son descritos en los archivos del directorio values/. -> (Activa) Los archivos del directorio values/ describen varios recursos.

  • (Pasiva) Un único recurso es definido en cada campo secundario del elemento <resources>. -> (Activa) El elemento <resources> define en cada campo secundario un único recurso

  • (Pasiva) Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos. -> (Activa) En los subdirectorios definidos han sido guardados tus recursos predeterminados

  • En los archivos del directorio values/ se describen varios recursos.
  • En cada campo secundario del elemento <resources> se define un único recurso.
  • En los subdirectorios definidos se guardan tus recursos predeterminados.

Voz pasiva

  • Varios recursos son descritos en los archivos del directorio values/.
  • Un único recurso es definido en cada campo secundario del elemento <resources>.
  • Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.

Voz activa

  • Los archivos del directorio values/ describen varios recursos.
  • En cada campo decundario del elemento <resources> se define un único recurso.
  • Los subdirectorios definidos guardaron tus recursos predeterminados.

📌 Lo que considero más importante:
.
La voz activa es el estándar para el technical writing. La mayor parte de las frases en la escritura técnica están en voz activa debido a que es más corta e interesante de leer. Además, la voz activa muestra claramente al sujeto en una situación, cuando leemos en esta voz gramatical sabemos quién hace qué y a quién.
.
Cuando hacemos listas lo recomendado es que las frases inicien con un verbo en modo imperativo. Por ejemplo:

  • Pulsa sobre «Nuevo» para crear una partición nueva.
  • Elige el tamaño de la nueva partición.
  • Reinicia el sistema varias veces.

Los recursos son descritos en los archivos del directorio values/
El elemento <resource> define un recurso por cada campo secundario
Tus recursos predeterminados son guardados en el subdirectorio definido

Se describen los recursos en los archivos del directorio values/.
En cada campo secundario del elemento se define un unico recurso<resources>
Los subdirectorios definidos guardan tus recursos predeterminados.

En los archivos del directorio values/ se describen varios recursos.
En cada campo secundario del elemento, se define un único recurso
En los subdirectorios definidos, se guardan tus recursos predeterminados.

  • En los archivos del directorio values/ se describen varios recursos.
  • En cada campo secundario del elemento se define un único recurso
  • En los subdirectorios definidos se guardan tus recursos predeterminados.
  1. En los archivos del directorio values/ se describen varios recursos.
  2. En cada campo secundario del elemento se define un único recurso.
  3. Los recursos que han sido guardados en los subdirectorios definidos son tus recursos determinados.

Aquí está mi solución al reto

Primera oración:

Los archivos del directorio values/ describen varios recursos.


Segunda oración:

Cada campo secundario del elemento define un único recurso.


Tercera oración:

Los recursos que han sido guardados en los subdirectorios definidos son tus recursos predeterminados.

¡Hola! A continuación el desarrollo del reto:

Varios recursos son descritos en los archivos del directorio values/.: Los archivos del directorio values/ describen varios recursos.

Un único recurso es definido en cada campo secundario del elemento.: En cada campo secundario del elemento se define un único recurso.

Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.: Tus recursos predeterminados se guardan en los subdirectorios definidos (no estoy seguro de ésta, aunque la idea es la misma 😄).

¡Saludos!

Los archivos del directorio values/ describen varios recursos.
Cada campo secundario del elemento define un único recurso.
Los recursos guardados en los subdirectorios definidos son recursos predeterminados.

Varios recursos son descritos en los archivos del directorio values/.
En los archivos del directorio values/. se describen varios recursos

Un único recurso es definido en cada campo secundario del elemento .
Para cada campo secundario del elemento se define un único recurso

Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.
En los subdirectorios definidos se guardan tus recursos predeterminados

  • Los archivos del directorio son descritos en varios recursos
     

  • Un único recurso es definido en cada campo secundario del elemento.
    En cada campo secundario del elemento es definido un único recurso.
     

  • En los subdirectorios definidos han sido guardados tus recursos predeterminados.

  • Los archivos del directorio son descritos en varios recursos.

  • Un único recurso es definido en cada campo secundario del elemento.

  • En cada campo secundario del elemento es definido un único recurso.

  • En los subdirectorios definidos han sido guardados tus recursos predeterminados.

  • En los archivos del directorio están descritos varios recursos

  • En cada campo secundario del elemento hay un único recurso definido

  • En los subdirectorios definidos se guardan tus recursos predeterminados

  • Varios recursos son descritos en los archivos del directorio values/.
  • En los archivos dell directorio values/ describe varios recursos.
  • Un único recurso es definido en cada campo secundario del elemento .
  • En cada campo secundario del elemento son definidos un único recurso.
  • Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.
  • En los subdirectorios definidos tus recursos predeterminados son guardados.

En los archivos del directorio values/ están descritos varios recursos.
En cada campo secundario del elemento se define un único recurso.
En los subdirectorios definidos se han guardado tus recursos predeterminados.

  • Se describen varios recursos en los archivos del directorio values/.
  • Se define un único recurso en cada campo secundario del elemento.
  • Tus recuerdos predeterminados son los que se guardan en los subdirectorios definidos.

En los archivos del directorio values/ se describen varios recursos
En cada campo secundario del elemento <resources> se define un único recurso
En los subdirectorios definidos se guardan tus recursos predeterminados

Algunos recursos están descritos en los archivos del directorio values/.
Un solo recurso esta definido en cada campo secundario del elemento .
Los recursos tuyos son predeterminados los recursos que han sido guardados en los subdirectorios definidos.

Se describen varios recursos en los archivos del directorio values/ .
Se define un recurso único en cada campo secundario del elemento <resources>
Se guardan tus recursos predefinidos en los subdirectorios definidos.

  • Varios recursos se describen en los archivos del directorio values/.

  • En cada campo secundario del elemento <resources> se define un único recurso.

  • Son tus recursos predeterminados los recursos que se han guardado en los subdirectorios definidos.

ACTIVO En los archivos del directorio values/ se describen varios recursos
ACTIVO El elemento <resources> tiene definido un único recurso en cada campo secundario.
ACTIVO Los recursos que han sido guardados en los subdirectorios definidos son tus recursos predeterminados

  • En los archivos del directorio values se describen varios recursos
  • En cada campo secundario del elemento resources se define solamente un recurso.
  • Los recursos guardados en los subdirectorios serán marcados como tus recursos predeterminados.
  1. En los archivos del directorio values/ se describen varios recursos.
  2. En cada campo secundario del elemento <resources> un único recurso se define.
  3. Los recursos guardados en los subdirectorios definidos son tus recursos predeterminados.
on the archive you will find some file descriptions every elemnt has it's definition on the second form field your predetermin resources had been save on the define subdirectories
En los archivos del directorio *values/* se describen varios recursos En cada campo secundario del elemetno se define un unico recurso En los subdirectorios definidos se guardan los recursos predeterminados
En los archivos del directorio values/ se describen varios recursos. En cada campo secundario del elemento se define un único recurso. Los recursos que han sido guardados en los subdirectorios definidos son tus recursos predeterminados.
En el directorio "values/" se encuentran varios de los recursos descritos En cada campo secundario del elemento es definido un unico recurso En los subdirectorios definidos se han guardado tus recursos predeterminados

los recursos son descritos en el direcorio /values en forma de archivos.

el recurso fue definido en los campos secundarios del elemento.

los recursos preterminados estan almacenados en los sudirectores definidos con anteriodidad.

  • En los archivos del directorio values/ se describen varios recursos.
  • En cada campo secundario del elemento se define un único recurso.
  • En los subdirectorios definidos se han guardado tus recursos predeterminados.

Si me pueden apoyar con feedback se los agradecería mucho.

  • Los archivos del directorio values/ describen varios recursos.
  • Cada campo secundario del elemento define un único recurso
  • Los subdirectorios definidos guardan tus recursos predeterminados.
  • El directorio values/ describe varios recursos

  • Cada campo secundario del elemento define un unico recurso

  • Tus recursos predeterminados se guardaon en los subdirectorios defindios

  • Los archivos del directorio Values/ describen varios recursos.
  • Cada campo secundario del elemento define un único recurso.
  • Los subdirectorios definidos guardan tus recursos predeteerminados.

Utilicé el recurso de los verbos imperativos, ya que estamos trabajando con una lista y que sólo de esta forma me quedan oraciones con sentido:

  • Describe varios recursos en los archivos del directorio values/.
  • Define un único recurso en cada campo secundario del elemento.
  • Guardaste tus recursos predeterminados en los subdirectorios definidos.
  • Los archivos del directorio values/. en varios recursos son descritos.

  • En cada campo secundario del elemento es definido un recurso único.

  • En los subdirectorios definidos han sido guardado tus recursos que son los recursos predeterminados.

Conste que no le copié a nadie, y si estoy mal corrijanme!

  • En los archivos del directorio value/ son descritos varios recursos.

  • En cada campo secundario del elemento un único recurso es definido.

  • En los subdirectorios definidos son tus recursos predeterminados los recursos que los que han sido guardados.

-Varios recursos son descritos en los archivos del directorio values/.

-Los archivos del directorio values se describe en varios recursos.

-Un único recurso es definido en cada campo secundario del elemento .

-En cada campo secundario del elemento se define un único recurso.

-Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.

-Los subdirectorios definidos se guardan como recursos predeterminados.

  • El directorio values/ contiene archivos que describen varios recursos

  • Los campos secundarios del elemento definen un único recurso

  • Tus recursos predefinidos se guardan en los subdirectorios definidos

Reto 👻

  • Los archivos del directorio values/ describen varios recursos

  • Cada campo secundario del elemento se define un recurso único.

  • Los subdirectorios definidos guardan tus recursos predeterminados.

Buenas! 😃
-Los archivos del directorio values/ describen varios recursos.
-Cada campo secundario del elemento define un único recurso.
-Tus recursos predeterminados son los que fueron guardados en los subdirectorios definidos.

Ejercicio:

  • Los archivos del directorio values/ describen varios recursos.
  • En cada campo secundario del elemento se define un único recurso.
  • Los recursos que se guardan en los subdirectorios definidos, son tus recursos predeterminados.

Solucion SM 🚀


  1. Los archivos del directorio values/. describen varios recursos.
  2. Cada campo secundario definen un unico recurso.
  3. Los subdirectorios definidos guardan los recursos que son Recursos predeterminados.

By SsimorPro

Hay momentos es que conviene usar la voz activa, como en un RCA(Root cause analysis), donde se pretende evitar el enfoque sobre quienes cometieron un error y darlo a los hechos. “Un costoso error fue hecho”.

Otro seria al explicar un proceso, sobre todo uno en que el lector no está activamente involucrado. “La inyección de código es prevenida con buenas prácticas de seguridad”.

1.-Los archivos del directorio values/ describen varios recursos.
2.-Cada campo secundario del elemento define un único recurso.
3.-Los subdirectorios definidos guardan tus recursos predeterminados.

  • Se describen varios recursos en los archivos del directorio values

  • En cada campo secundario del elemento se define un único recurso.

  • En los subdirectorios definidos se guardan tus recursos predeterminados

Reescribiendo las oraciones de voz pasiva a voz activa:

Varios recursos son descritos en los archivos del directorio values/.

Voz activa

Varios recursos son descritos en los archivos del directorio values

• Un único recurso es definido en cada campo secundario del elemento.

Voz activa:

En cada campo secundario del elemento es definido un único recurso

• Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.

Voz activa:

En los subdirectorio definidos han sido guardados los recursos predeterminados

Ejercicio:

  • P: Varios recursos son descritos en los archivos del directorio values/.
    - A: Los archivos del directorio values/ describen varios recursos.

  • P: Un único recurso es definido en cada campo secundario del elemento .
    - A: Cada campo secundario del elemento define un único recurso.

  • P: Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.
    - A: Los subdirectorios definidos guardan tus recursos predeterminados.

Este es mi aporte con referencia a la voz activa y pasiva.

Los recursos son descritos en el directorio values/.

Un recurso es definido en cada campo secundario del elemento .

Los recursos predeterminados han sido guardados en los subdirectorios definidos.

  • Los archivos del directorio /values describen varios recursos.
  • El campo secundario de cada elemento define el recurso.
  • En los subdirectorios definidos se guardan tus recursos predeterminados.

Acá está mi solución al reto de esta clase, espero haberlo hecho bien:
Los archivos del directorio values/ describen varios recursos.
Cada campo secundario del elemento define un único recurso.
Los subdirectorios guardan tus recursos predeterminados.
Si alguien logra ver algún error, estoy abierto a opiniones.

En los archivos del directorio values/ se describen varios recursos.
Se define un único recurso cada campo secundario del elemento.
Se guardan en los subdirectorios definidos tus recursos predeterminados.

  • Los archivos del directorio values/. describen varios recursos
    *Cada campo secundario del elemento describe un único recurso
    *Los subdirectorios definidos guardan tus recursos predeterminados
  • Los archivos del directorio values/ describen varios recursos
  • Cada campo secundario del elemento define un unico recurso
  • Los subdirectorios definidos guardan turs recursos predeterminados
  • Los archivos del directorio values/ describen varios recursos.
  • Cada campo secundario del elemento define un unico recurso.
  • Los subdirectorios definidos guardan tus recursos predeterminados.
  • Los archivos del directorio values/ describe varios recursos.

  • Definir en cada campo secundario del elemento un unico recurso.

  • Los recursos que se guardan en los subdirectorios definidos serán los recursos predeterminados.

En los archivos del directorio

values/

se describen varios recursos.
En cada campo secundario del elemento se define un único recurso.
En los subdirectorios definidos se gurdan tus recursos predeterminados.

Ejercicio de la clase:

  • Los archivos del directorio values/ describen varios recursos.
  • Cada campo secundario del elemento define un único recurso.
  • Los subdirectorios definidos guardan tus recursos predeterminados.

Creo que está es mejor que la anterior:

• Varios recursos son descritos en los archivos del directorio values/. 
• Los archivos del directorio values/ describen varios recursos.
• Un único recurso es definido en cada campo secundario del elemento 
• Cada campo secundario del elemento define un único recurso.
• Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos. 
• Los subdirectorios definidos han guardado tus recursos predeterminados
• Varios recursos son descritos en los archivos del directorio values/. 
• En los archivos del directorio values/ se describen varios recursos.
• Un único recurso es definido en cada campo secundario del elemento 
• En cada campo secundario del elemento se define un único recurso.
• Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos. 
• En los subdirectorios definidos se han guardado tus recursos predeterminados

• Los archivos del directorio values/ describen arios recursos

• Cada campo secundario del elemento define un único recurso.
• Los subdirectorios definidos guardan tus recursos predeterminados.

  • Los archivos del directorio values/ describen varios recursos.
  • Cada campo secundario del elemento define un único recurso.
  • Tus recursos predeterminados son los recursos a guardar en los subdirectorios definidos.

Respuesta al reto, tratando de seguir la estructura: sujeto + verbo + objetivo:

  • Los recursos se describen en los archivos del directorio values/
  • Se define un solo recurso en cada segundo campo del elemento
  • Tus recursos predeterminados se guardaron en los subdirectorios definidos

Reto de la clase:

  1. Los archivos del directorio values/ describen varios recursos.
  2. Cada campo secundario del elemento define un único recurso.
  3. En los subdirectorios definidos se guardan tus recursos predeterminados.

Solución al reto:

  • Varios recursos son descritos en los archivos del directorio values/.
    • En los archivos del directorio values/ se describen varios recursos.
  • Un único recurso es definido en cada campo secundario del elemento .
    • En cada campo secundario del elemento se define un único recurso
  • Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.
    • En los subdirectorios de definidos se guardan tus recursos predeterminados.

Transformarlos a voz activa

  • Varios recursos son descritos en los archivos del directorio values/.

Voz activa: En los archivos del directorio values/. se describen varios recursos

  • Un único recurso es definido en cada campo secundario del elemento

Voz activa: En cada campo secundario del elemento se define un único recurso

  • Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.

Voz activa: En los subdirectorios definidos han sido guardados los recursos predeterminados.

  1. el directorio values describe varios recursos
  2. el campo secundario del elemento solo define un recurso
  3. los recursos predeterminados son guardados en los subdirectorios definidos
  • Los archivos del directorio values/ describen varios recursos.

  • Cada campo secundario del elemento define un único recurso.

  • Los recursos guardados en los subdirectorios definen los recursos predeterminados.

  • En los archivos del directorio “values/.” se describen varios recursos
  • En cada campo secundario del elemento se define un único recurso
  • Tus recursos han sido guardados en los subdirectorios definidos

Veo que las respuestas de la mayoría son diferentes y se pueden interpretar de distinta forma :S , me pregunto ¿Cuáles respuestas son correctas? y ¿Por que si estoy escribiendo en Markdown mi texto sale pegado? 😦


Pasivo - Varios recursos son descritos en los archivos del directorio values/.

Activo - Varios de los archivos del directorio values/ son recursos descritos


Pasivo - Un único recurso es definido en cada campo secundario del elemento .

Activo - Cada campo secundario del elemento es un único recurso definido.


Pasivo - Son tus recursos predeterminados los recursos que han sido guardados en los subdirectorios definidos.

Activo - Los recursos guardados en los subdirectorios definidos, son predeterminados.

  • Varios recursos se describen en los archivos del directorio values/.
  • Un único recurso se define en cada campo secundario del elemento <resources>.
  • Son tus recursos predeterminados aquellos que se guardan en los subdirectorios definidos.
  1. En los archivos del directorio values/, se describen varios recursos.
  2. Define un único recurso en cada campo secundario del elemento <resources>.
  3. Los recursos que se guardan en los subdirectorios definidos, son recursos predeterminados.

Solución:

  1. Los archivos del directorio values/ se describen varios recursos.
  2. En cada campo secundario del elemento se define un único recurso.
  3. Los recursos que se guardan en los subdirectorios definidos son tus recursos predeterminados.
  • Los recursos se describen en los archivos del directorio values/.

  • en cada campo secundario del elemento se define un unico recurso.

  • Los subdirectorios definidos guardan los recursos predeterminados

Los archivos del directorio values/ varios recursos son descritos (voz activa).
En cada campo secundario del elemento,Un único recurso es definido (voz pasiva)
Los recursos que han sido guardados en los subdirectorios definidos. son predeterminados.(voz activa)

  1. Los archivos del directorio values/ describen varios recursos.
  2. Cada campo secundario del elemento define un único recurso.
  3. Se guardaron tus recursos predeterminados en los subdirectorios definidos
  • Hay varios recursos descritos en los archivos del directorio values/.
  • En cada campo secundario del elemento se describe un único recurso.
  • En los subdirectorios definidos se guardan tus recursos predeterminados.
• En los archivos del directorio values/ son descritos varios recursos.
• En cada campo secundario del elemento se define un único recurso.
• Los recursos guardados en los subdirectorios definidos, son tus recursos predeterminados.

En los archivos del directorio values/. se describen varios recursos.
En cada campo secundario del elemento se define un unico recurso.
Los recursos que han sido guardados en los subdirectorios definifos son tus recursos predeterminados.

  • Los archivos del directorio values/ describen varios recursos

  • Cada campo secundario del elemento define un unico recurso

  • Los subdirectorios definidos guardan los recursos predeterminados

En los archivos del directorio varios recursos son descritos.
En cada campo secundario del elemento un único recurso es defnido.
Los recursos que han sido guardados en los subdirectorios definidos son tus recursos predeterminados.

En los archivos del directorio values/. se describen varios recursos.

En cada campo secundario del elemento se define un único recurso.

En los subdirectorios definidos se han guardado tus recursos predeterminados.

  • En los archivos del directorio varios recursos son descritos.
  • En cada campo secundario del elemento un único recurso es definido.
    -Los recursos que han sido guardados en los subdirectorios definido son tus recursos predeterminados
  • En los archivos del directorio values/ se describen varios recursos.

  • En cada campo secundario del elemento se define un único recurso.

  • Los recursos que han sido guardados en los subdirectorios definidos son tus recursos determinados.

  • En el directorio values/ estan descritos varios recursos.

  • En cada campo secundario del elemento esta definido un único recurso.

  • Los recursos guardados en los subdirectorios definidos son tus recursos predeterminados.

En los archivos del directorio values/, se describen varios recursos

En cada campo secundario del elemento se define un único recurso.

En los subdirectorios definidos se han guardado los recursos predeterminados

Muy buena explicación acerca de la voz activa y la voz pasiva.