Gestión de Bases de Datos Relacionales

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

Clase anteriorSiguiente clase

Juan Carlos García Esquivel

student•

Les comparto algunos casos de uso en lo que me a tocado aplicar la Technical Writing para cada área especificada:

Información técnica: Puede ser en un manual de usuario donde todos los aspectos que conforman un sistema deben ser redactados de tal forma que el usuario que va a implementarlos tenga una idea clara y precisa de cómo debe de utilizarse.
Ideas: En parte inicial del siclo de vida de desarrollo de software nos encontramos con el análisis de requerimientos donde una de las tareas mas importantes en esta etapa es tomar las ideas que el cliente desea y comunicarlas al equipo de diseño y desarrollo de tal forma que sea clara para todas las partes procurando no tener ambigüedades.
Conceptos: Esta parte de conceptos podemos encontrarla en la documentación de cualquier tecnología esta documentación esta dirigida a desarrolladores y utilizando como es el concepto de Technical Writing el lenguaje del arte lo que es lo mismo el lenguaje técnico de programación con lo que también podemos ver que se usa el concepto del publico objetivo para el que se escribe.
Procesos complejos: Esto se puede encontrar en manuales de procesos donde tenemos documentados todo un procedimiento completo con sus interacciones esto es muy importante ya que nos permite realizar la operación de ciertas actividades de una forma ordenada y establecida ya que existen procesos críticos un ejemplo es el manejo de hidrocarburos donde si no se hace de manera adecuada según el procedimiento documentado podría pasar un accidente fatal que costaría incluso muchas vidas. Espero que les ayude a entrar un poco en contexto de cada caso de uso 😀

Karla

student•

Gracias por la información 💚

Juan Carlos García Esquivel

student•

No hay de que @karla-agraz :)

Luis Alejandro Ortega Bermudez

student•

Si no puedes explicarlo simplemente, es porque no lo entiendes suficiente. Creo que muchos hemos oído este tipo de frases.

Kevin Manuel Wong

student•

Es verdad, pero es dificil de aceptar.

Gonzalo Peñaranda

student•

O puedes ser capaz de explicar algo, no todo. Creo que es otra forma de decir lo mismo que dijiste, pero...igual quería agregarlo.

DANIEL SUAREZ

student•

Aqui es donde me doy cuenta que el Ingles es fundamental :) animo a todos mis compañeros a aprender Ingles para ser un buen " Technical Writer "

Carlos Rodríguez

student•

Good :D.

Esteban Josué Alvarado Vargas

student•

Habilidades de un Techncal Writer

Escribir claramente en su idioma natal. 🇪🇸
Escribir claramente en inglés. 🇺🇸
Aprender tecnologías complejas con relativa rapidez. 🔭
Explicar tecnologías complejas de manera útil para el público objetivo. 🎯
Tener fuertes habilidades interpersonales. 🤝
Comprender el código de lenguajes de programación. 💻

Alvaro Legarda

student•

Muchas gracias por tu aporte. En cuanto al manual del usuario, salvo que sea un manual técnico debe contener especificaciones muy precisas, Si es para el consumidor final tipo persona sin conocimientos técnicos pues debe ser mas bien muy claro sin entrar en detalles del funcionamiento.

Carlos Rodríguez

student•

Grande.

Juan Esteban Galvis

student•

La escritura es fundamental y para ello termine la ruta de Periodismo Digital. Me falta aprender Ingles jaja y claro todo el mundo debería saber programar y para hacer Technical Writer con mayor razón.

Mi Chu

student•

Considerando hacer lo mismo 👀

Carlos Rodríguez

student•

Yes!

Nahuel Brandan

student•

Tiangolo, el creador del framework FastAPI, el tercer framework de desarrollo web más utilizado de Python, cuenta que dedico mucho más tiempo a la documentación que a la implementación en sí. Esto es un claro ejemplo de la importancia del Technical Writing.

Mi Chu

student•

Impresionante 🤯

Agustin Montoban

student•

Lo que mas rescato en estas dos primeras clases es la importancia de ayudar a las personas a " ENTENDER" en un lenguaje simple.

Mi Chu

student•

Me sorprende el nivel de simpleza con el que muchos productos consultando su documentación sin saber nada del tema comienzo a entenderlo desde la primera lectura 🤯

Daniel Libardo Diaz Gonzalez

student•

No se preocupen si no saben Inglés 🇬🇧. Solo comienzen a escribir "right away".

Ese encontronazo con no saberte expresar bien, o tener que revisar una y otra vez lo que escribiste es lo que realmente te hace progresar para aprender Technical Writing.

Andrés González

student•

Otro uso importante del technical writing es cuándo vamos a entregar un puesto de trabajo. Para que la persona que venga tenga un mejor onboarding

Kristopher Ortega

student•

Listo!

Jimmy Buriticá Londoño

student•

Es muy importante siempre pensar en el público objetivo.

Arredondo Escoto Jose Antonio

student•

La mayoría de las veces cuando trabajas con muchas personas, tienes que hacer tu trabajo pensando que alguien más lo va a utilizar, entonces, creo que es muy importante tener una documentación bien organizada para que se pueda entender.

Royer Guerrero Pinilla

student•

Creo que los technical writers no solo se quedan en programación, sino ciencias en general (Matematicas, Fisica, Biologia, Quimica) y pues todas ciencias que derivan de las anteriores que son mas complejas (Astrobiologia, Fisica Cuantica, etc)

Aurelio ML

student•

Es un trabajo muy importante que puede adaptarse a todas las ciencias :)

Daniel Andres Rojas Paredes

student•

Graso error de accesibilidad en esta clase, la imagen no tiene alt textb

María del Consuelo Irastorza Vázquez

student•

Habilidades para convertirte en Technical Writer

Información técnica Ideas Conceptos Procesos complejos

Explicar tecnologías complejas de manera útil para el público objetivo Fuertes habilidades interpersonales Escribir claramente en inglés y tu idioma natal Comprender el código de lenguajes de programación Aprender tecnologías complejas con relativa rapidez.

Carlos Rodríguez

student•

Gran introducción :D.