Conocimientos y habilidades que adquieres realizando este taller

  • Qué es la documentación técnica.
  • Quién debe escribirla y para quién se escribe.
  • Por qué es tan importante crear la documentación técnica.
  • Tipos de documentación técnica y cómo elegir entre ellos.
  • Dónde alojarla una vez se finalice su elaboración.
  • Aspectos a cuidar para ofrecer una UX de calidad y qué errores evitar.
  • Recomendaciones a la hora de realizar una escritura técnica.
  • Ejemplos reales de buenas prácticas aplicadas en documentos técnicos.
  • Cómo verificar que la documentación está resultando útil a los usuarios.
  • Qué indicadores medir y qué herramientas utilizar para ello.
  • Cómo mejorar la usabilidad del usuario en caso de necesitarlo.

Relacionado

Te dejamos una selección de cursos, carreras y artículos

Gestión de documentación técnica con GitHub y Markdown

Gestión de documentación técnica con GitHub y Markdown

taller

Con este taller aprenderás:

  • Qué es documentación técnica y sus fundamentos.
  • Las herramientas necesarias para producir documentación técnica.
  • Qué lenguaje utilizar para escribir documentación y los motivos.

Duración: 1 hora y 17 minutos

Curso de Git

Curso de Git

curso

Con este curso aprenderás:

  • Aprenderás qué es un repositorio, una rama o una etiqueta
  • Conocerás los principales parámetros de trabajo con GIT
  • Aprenderás cómo trabajar con un servidor GIT básico y usaremos Gitlab

Duración: 2 horas y 52 minutos

Preguntas Frecuentes

En OpenWebinars ni los cursos ni los talleres tienen fecha de inicio o final.

Cada taller tiene una fecha de publicación y desde ese día lo tienes 100% disponible si estás suscrito a alguno de nuestro planes.

En OpenWebinars no vendemos cursos o talleres unitarios.

Tenemos diferentes tipos de suscripciónes, que te dará acceso completo a todos los cursos de la plataforma y a los nuevos que vamos lanzando, siempre y cuando tu suscripción esté activa (como Spotify con la música o Netflix con las películas y series).

¿Eres una empresa? Tenemos planes especiales para tí. Consúltanos aquí.

Descripción

Suele ocurrir que dejamos en un segundo plano la generación de la documentación técnica de nuestro software, ya que resulta una tarea tediosa y normalmente es la parte más descuidada de todo proyecto.

Este tipo de documentación debe ser elaborada para que el usuario pueda consultarla para conocer a fondo el producto, y no para ser leída como si otro tipo de texto se tratase, por lo que debe hacerse siguiendo unas pautas y teniendo en cuenta ciertas consideraciones.

En este taller vamos a ver a fondo cuales son las mejores prácticas a la hora de crear documentación técnica asociada a nuestro software, para que la experiencia de los usuarios a la hora de consultarla sea la mejor y ofrezca el contenido esperado.

Para ello te contamos qué es la documentación técnica, su función y cuáles son sus características principales, de forma que aprendas a crearla de la forma adecuada, para que el usuario final tenga claro todo lo que necesite consultar.

Otro aspecto importante es quién o quiénes deben ser las personas encargadas de crear este tipo de textos, porque tiene influencia en el resultado final, al igual que hay que saber para quién se crea esta documentación y la importancia de crear la misma.

También debes saber los diferentes tipos que existen de documentación y qué preguntas debes hacerte para poder elegir el más adecuado en cada caso que sea necesario desarrollar la misma.

Una vez que ya se ha creado el final, existen diferentes formas de alojar la misma, para ello te hablamos de la posibilidad de alojarla directamente en una web o un blog, o bien utilizando un repositorio como GitHub.

En ambos casos hay que saber cómo hacer que la experiencia de usuario sea la mejor a la hora de consultar nuestro documento técnico, por lo que te detallamos cuáles son los errores más comunes que hay que evitar en cada uno de esos casos.

Para completar el taller, queremos que conozcas las mejores recomendaciones a la hora de comenzar a hacer una escritura técnica, para ello primero detallamos lo que se conoce como las 7 C’s de la escritura técnica y después te contamos nuestras recomendaciones.

También te mostraremos una serie de ejemplos reales, de empresas muy conocidas, que aplican todas estas buenas prácticas a la hora de elaborar su documentación técnica.

Finalmente te hablamos de cómo comprobar que nuestra documentación está siendo útil al usuario de la misma. Para ello te contamos una serie de ideas para valorar los resultados, qué KPis se deben medir y qué herramientas se utilizan para ello, además cómo mejorar la usabilidad en caso de necesitarlo.

Entra ahora en este taller de Raquel Campuzano, Content Manager de Bitnami, y aprende las mejores prácticas crear una documentación lo más profesional posible y mejorar así la experiencia del usuario de la misma.

* Requisitos del Taller

Este taller está pensando como ayuda inicial a la hora de comenzar a desarrollar documentación técnica, por lo que no son necesarios conocimientos previos para seguirlo de una forma correcta.

Estas son algunas de las empresas que ya confían en OpenWebinars

Profesores y profesionales

Nuestros docentes son profesionales que trabajan día a día en la materia que imparten

Conviértete en profesor de OpenWebinars