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

¿Qué es programación? Evolución de la documentación y technical writing

11/20

Lectura

Así como documentar no solo consiste en escribir texto, escribir tampoco es la única habilidad requerida para una technical writer, también necesitamos otras habilidades para usar herramientas profesionales y crear documentación. Los días en que las technicals writers solo usaban Microsoft Word ya pasaron de moda, ahora se pone más atención en los detalles: imágenes, videos, ilustraciones, diagramas, etc.

Esto se debe a que la tecnología es un mundo igualmente inmenso a la cantidad de tipos de documentación que podemos encontrar; son varios los formatos en que puedes escribir: cartas de aplicación, instrucciones, descripciones, manuales de instalación y muchos otros.

Familiarizándote con la programación 👨‍👨‍👧

Durante tu trayectoria se atravesará algún momento en el que tengas que documentar un bloque de código, APIs o proyectos de software. Estos elementos están creados con lenguajes de programación. Y para esto es obligatorio conocer de manera global qué es la programación, para que tus escritos sean enfocados a tus lectores con el fin de que comprendan cómo funciona cada bloque de código del proyecto de software que documentaste.

Como technical writer no es necesario que sepas programar como una desarrolladora. El único objetivo es que estés familiarizada con los conceptos de programación, tener habilidades de leer código y otras competencias básicas. Cabe señalar que si sabes programar, son puntos a favor, si no lo sabes, no te preocupes, puedes aprender a hacerlo.

Si te preguntas por dónde empezar, te recomiendo el Curso Gratis de Programación Básica de Platzi. Será un gran complemento a tu carrera como technical writer.

aprende a programar

Recuerda que a lo largo de tu profesión trabajarás con diferentes profesionales en diversos proyectos y deberás entender de qué te hablan. Como este curso está enfocado a crear documentos técnicos es primordial que conozcas principalmente terminologías y conceptos básicos de programación.

A continuación te explicaré qué es, cómo se hace y para qué sirve la programación sin hacer hincapié en cuestiones técnicas. Solo quiero que entiendas qué es la programación en términos simples.

Aspectos básicos de la programación 👩‍💻

La programación es una forma de enseñar a los ordenadores a hablar nuestro idioma de la forma en que lo entendemos. La programación no se trata de aprender, sino de entender cómo transmitir nuestras necesidades a la computadora. Es un proceso de construcción de un programa ejecutable para una tarea computacional específica. Implica perfilar la precisión y generación de algoritmos además del consumo de recursos que utilizaremos.

Los algoritmos se crean usando lenguajes de programación. Estos lenguajes son un conjunto de símbolos y códigos que se usan para orientar la programación. A través de una serie de instrucciones, datos y algoritmos podemos controlar el comportamiento lógico y físico de una máquina. Para profundizar un poco más en estos conceptos te recomiendo que tomes la Carrera de Fundamentos de Programación de Platzi, aquí conocerás más a fondo las normas y buenas prácticas que hacen del código un texto legible.

Curso de Buenas Prácticas para Escritura de Código

Hasta ahora hay varios lenguajes de programación y seguirán creándose más. Los lenguajes de programación se clasifican en dos tipos:

  • Los lenguajes de bajo nivel son en su mayoría lenguajes ensambladores que hablan directamente con el procesador, por lo que necesitan menos compilación.
  • Los lenguajes de alto nivel son avanzados y poderosos para programar y obtener la salida que deseamos. En cada computadora los lenguajes de alto nivel se convierten en lenguajes de bajo nivel y luego alimentan al procesador para procesar las solicitudes.

No todos los lenguajes de programación son del más alto o el más bajo nivel. También hay muchos intermedios.

Este trabajo lo hacen los compiladores, las herramientas encargadas de la conexión con las máquinas de forma programada. Convierten el lenguaje que escribimos en un lenguaje comprensible para la máquina.

Lenguajes de programación modernos 👼

Según Career Karma, en el mundo existen aproximadamente 9,000 lenguajes de programación, aunque los más populares e incluso los más modernos son alrededor de 50. Algunos ejemplos de lenguajes de programación modernos son C, C++, Swift, Java, JavaScript, Python, Ruby, C#.

La mayoría de estos lenguajes de programación son de alto nivel y tienen estos fundamentos básicos:

  • Fiabilidad: se trata de la frecuencia con la que el resultado de un programa es correcto.
  • Robustez: la facilidad con la que un programa puede detectar errores o fallos.
  • Usabilidad: cuánto mejor un programador puede usar el lenguaje para servir a su propósito.
  • Portabilidad: es el rango de compilación del lenguaje donde se ejecuta dependiendo del sistema operativo, el hardware.
  • Mantenibilidad: la facilidad de cómo el programa puede ser modificado para futuras actualizaciones o adiciones.
  • Eficiencia: medida de los recursos del sistema que un programa consume, como los ciclos de la CPU, la memoria, etcétera.

Empezando con la programación 💪

Para tener tu primer acercamiento con el mundo de la programación no necesitas mucha experiencia. Si sabes matemáticas e inglés básico, puedes empezar fácilmente. Aprender a programar te ayudará cada día a abordar los problemas de manera diferente.

Mi sugerencia es empezar por lo básico. Lee blogs y libros sobre un lenguaje de programación de tu interés, toma cursos para principiantes (como los cursos de introducción que encuentras en Platzi) y encuentra algunos recursos en línea para practicar por tu cuenta. Lo importante es que tengas idea de lo que son las funciones, las variables, las declaraciones, las condiciones y los bucles. Siempre es mejor empezar por ahí cuando no tienes ningún conocimiento.

La filosofía del programador: Ventajas de aprender a programar

En verdad, si tienes oportunidad de aprender a programar, hazlo. Es una parte fundamental de nuestra preparación para saber lo que está sucediendo en nuestro mundo. La programación es como la meditación: te da diversión, conciencia de ti mismo y la capacidad de resolver problemas.

Para finalizar, quizás te preguntes si como technical writer necesitarás aprender un lenguaje de programación o no. Mi respuesta es que eso dependerá de los requisitos e intereses de tu trabajo. Pero, por supuesto, si aprendes un lenguaje de programación créeme que te ayudará a ascender más rápido en tu carrera.

Escribe tu primer “¡Hola, mundo!” 👨‍💻👩‍💻

Ahora que ya tienes un poco más de contexto acerca de qué es la programación, ¿qué te parece si programas tu primer “¡Hola mundo!”? Es bastante sencillo, elige un lenguaje de programación que sea de tu interés, ¡el que quieras! Estoy segura de que de esta manera te quedará más claro el tema que vimos en esta clase. ¡Déjanos tus resultados en los comentarios! 💪

Aportes 27

Preguntas 0

Ordenar por:

¿Quieres ver más aportes, preguntas y respuestas de la comunidad? Crea una cuenta o inicia sesión.

“La programación es como la meditación” 👀 jajaja es una afirmación muy rara, pero me gustó 😆 .

Ni por equivocación había antes pensado en aprender programación y estás clases me han metido un poco la espinita… Se ve interesante y más útil de lo que pensé. 😅😉

Todo el mundo debería aprender a programar. En mi opinión no se debería solo aprender a programar sino también a diseñar y conocer los fundamentos de otras áreas. Dejo unos cursos de Platzi para aprender los fundamentos de diferentes áreas:

Fundamentos de Ingeniería de Software (TODOS deberían tomar este curso)
https://platzi.com/clases/ingenieria/

Introducción al Diseño:
https://platzi.com/clases/fundamentos-diseno/

Introducción al Desarrollo Web:
https://platzi.com/clases/html5-css3/

Introducción al Marketing:
https://platzi.com/clases/introduccion-marketing/

Básico de Python:
https://platzi.com/clases/pythonbasico/

Básico de JavaScript:
https://platzi.com/clases/basico-javascript/

Introducción al Lenguaje Audiovisual
https://platzi.com/clases/lenguaje-audiovisual/

print("No entiendo la obsecion con Hola Mundo");```

En C

#include <stdio.h>
int main()
{
    printf("Hola Mundo");
    return 0;
}

I love it 😍

def run():
    print('Hello World!')


if __name__ == '__main__':
    run()

Algo que me parece importante mencionar en todo esto es que, en programación puedes escribir tests, es decir, pruebas unitarias que permitan evaluar que una funcionalidad realmente se ejecuta correctamente. Y lo genial es que al escribir tests también estás documentando, esto porque un test básicamente te dice cómo se debe comportar cierta parte del programa 😄

Mi interés por mejorar como Technical Writer, me ha involucrado en aprender Python y R

Gracias, la programación debería ser una materia más en todos los niveles escolares.

#!/usr/bin/python3

if __name__ == '__main__':
	print('¡Hola, mundo!')

Programar como mi estilo de vida

print(“Hola mundo!”)

En Python es sencillo

print("Hola, Platzi")

Recuerdo cuando estaba estudiando la carrera de ingeniería de sistemas en la unviersidad, el primer hola mundo fue en pseudocódigo a mano y luego en computador en C++

Hola mundo en python
print("¡Hola, mundo!")

Python

print(“¡Hola mundo!”)

Console.writeLine("Hello world!");

**“La programación es como la meditación: te da diversión, conciencia de ti mismo y la capacidad de resolver problemas”
**

Genial!!!

console.log(“Hola Mundo”)

cout>>“Hello world”;

<?php
            echo "¡Hola Mundo!";
?>

Lo que más me gusta de programar es que puedo crear las cosas a mi manera, es lo que más me divierte.

console.log('Hola mundo') alert('hola mundo')

print('Hola mundo.')
<code>
print('Hola mundo')
using System;

 class HelloPlatzi
 {
     public static void Main()
     {
         Console.WriteLine("Hola, Platzi!");
     }
 }

Ya se programar, ahora estoy interesado en documentar los programas de una forma profesional.