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

No se trata de lo que quieres comprar, sino de quién quieres ser. Invierte en tu educación con el precio especial

Antes: $249

Currency
$209

Paga en 4 cuotas sin intereses

Paga en 4 cuotas sin intereses
Suscríbete

Termina en:

11 Días
21 Hrs
9 Min
51 Seg

¿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.

...

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

Aportes 31

Preguntas 0

Ordenar por:

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

“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/

En C

#include <stdio.h>
int main()
{
    printf("Hola Mundo");
    return 0;
}
print("No entiendo la obsecion con Hola Mundo");```

En Python es sencillo

print("Hola, Platzi")

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 😄

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

I love it 😍

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


if __name__ == '__main__':
    run()

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

"La programación es como la meditación" tambien me dio risa esta afirmación, pero tambien me parecio acertada la parte de "te da diversión, conciencia de ti mismo y la capacidad de resolver problemas." No estoy segura si para mi sea una forma de meditar, pero si puede ser una forma de generar autoconciencia, el aprendizaje no es lineal, tienes que tener alta tolerancia a la frustración para no abandonar y mucha resiliencia. Aunque me ha dado mucha felicidad, retos y tranquilidad laboral, tambien ha sido en algunos casos, frustrante y estresante. 🥲
print("¡Hola mundo!")
<public class HolaMundo {
    public static void main(String[] args) {
        System.out.println("¡Hola mundo!");
    }
}
> 


let gretting = “Hello, World!”;
console.log(gretting);
//Hello, World!

print(“Hola mundo!”)

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++

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.