Gramática Básica para Technical Writing

Clase 5 de 20Curso de Introducción al Technical Writing y Documentación de Código

La gramática es el arte de hablar y escribir CORRECTAMENTE una lengua. Y es esencial en el technical writing, ya que como creador de documentos técnicos, tu escritura debe de ser clara y gramaticalmente correcta.

https://images.pexels.com/photos/1841204/pexels-photo-1841204.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=650&w=940

Photo by Suzy Hazelwood from Pexels

Sería incongruente dedicarte a escribir y que no sepas aplicar los conceptos de la gramática básica, así que demos a nuestra mente un refresh por aquellos términos que a veces ya damos por sentados y que no está de más dar un breve repaso.

technical-writing2.png

Sustantivos 🕺

Los sustantivos representan objetos, personas, animales o lugares con nombre propio. Alejandra, México y taza son sustantivos, pero también lo son conceptos intangibles como la palidez o la optimización. Identifiquemos los sustantivos en la siguiente oración:

  • "Los drones son parte de la transformación digital que vivimos hoy en día".

  • "La impresión 3D está empezando a ocupar cada vez más espacio en el cine".

Si pensamos en código, las clases, variables y objetos funcionan como los sustantivos de tu programa.

Pronombres 💃

La función principal del pronombre es la de sustituir al sustantivo o hacer referencia a este. De esta forma, ayuda a no repetir varias veces un sustantivo dentro del enunciado utilizando otros términos tales como "él", "ese" o "aquel".

  • "José se veía preocupado. Su madre le había llamado muchas veces, pero él no contestó el teléfono".

En el enunciado anterior, la primera frase nos señala que "José" es el sustantivo y en la segunda frase los pronombres "le" y "él" sustituyen al sustantivo.

Verbos 🏃‍♀️

Un verbo es una parte importante de las frases que describen un suceso, una acción mental/física o la existencia de una condición o un estado (existir, ser). Cada frase que escribas debe contener al menos un verbo y este representa la relación entre el actor y el objetivo.

  • “A Patrick le gusta el vino”.

  • “Carlos estudia en línea”.

  • “Los niños aprenden robótica”.

  • “Mi hermano publicó su investigación”.

  • “Alberto trabaja en el día y estudia en la noche”.

  • “Karla iba cantando en la calle”.

Adjetivos y adverbios ✌️

Los adjetivos califican al sustantivo, veamos un ejemplo de ello:

  • "Gerardo compra cámaras nuevas para grabar videos profesionales".

Los adverbios modifican el significado del verbo, de otro adjetivo o de otro adverbio. Por ejemplo, nota como el adverbio (eficazmente) modifica el verbo (ejecuta):

  • "La computadora ejecuta varios programas eficazmente".

El adverbio no debe estar separado del verbo, también puede estar junto a este:

  • "La computadora ejecuta eficazmente varios programas".

Preposición 🤝

Las preposiciones son palabras invariables que se utilizan para establecer una relación de dependencia entre dos o más palabras.

  • "Los programas escritos con JavaScript se pueden probar directamente en cualquier navegador sin necesidad de procesos intermedios".

Conjunción y transición 🖇

Las conjunciones son palabras que se utilizan para unir dos o más partes de una oración o dos o más oraciones. Las más comunes son: "y", "pero" y "o".

  • "Nos creemos muy listos y muy mayores, pero nos hemos perdido una infancia entera de introducción a la programación o nunca tuvimos interés en ello".

Las transiciones más importantes usadas en technical writing son: “por ejemplo”, “sin embargo”, “en primer lugar” y “además”. A continuación te comparto un ejemplo de esto:

"El Manual de Instalación tiene como objetivo servir de guía en la instalación del sistema. En primer lugar, deberá especificar los requerimientos hardware y software necesarios para el correcto funcionamiento del sistema, para posteriormente describir cada uno de los pasos necesarios (por ejemplo: la configuración, compilación e instalación del sistema). Además, se deberán incluir las pruebas que se deberán realizar para asegurar que la instalación se ha realizado correctamente, así como el procedimiento de marcha atrás a aplicar en caso de que no haya resultado exitosa la instalación del sistema".

La gramática también forma parte importante de la escritura y es de gran relevancia para transmitir ideas e información. Así que, si aspiras a hacer un buen trabajo como technical writer, debes de estar bien preparado y dominar a la perfección tu gramática.

Curso de Ortografía Básica

¿Sabes diferenciar estos conceptos? 🕹

Como reto de esta clase debes identificar en las siguientes oraciones cuáles son sustantivos, pronombres, verbos, adjetivos, adverbios, conjunciones y transiciones.

Identifica el sustantivo:

  • JavaScript es uno de los más potentes e importantes lenguajes de programación en la actualidad.

Identifica el pronombre:

  • El primer estándar que creó el comité TC39 se denominó ECMA-262, en él se definió por primera vez el lenguaje ECMAScript.

Identifica el verbo:

  • Los programadores prefieren la denominación ECMAScript.

Identifica el adjetivo y el adverbio:

  • El requisito imprescindible para cualquier programador es un formulario principalmente.

Identifica la conjunción y transición:

  • El DOM permite a los programadores web acceder y manipular las páginas XHTML como si fueran documentos XML. Además, manipula de forma sencilla los documentos XML.


¡Deja tus resultados en los comentarios! En la próxima clase aprenderemos cómo definir términos importantes y cuándo usar acrónimos o abreviaturas.