Metodologías

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

Aprende a crear documentación técnica de forma fácil y profesional utilizando GitHub y Markdown para documentar un proyecto profesionalmente.

Impartido por:

4.5 (262 valoraciones)
1 hora y 17 minutos · taller
Gestión de documentación técnica con GitHub y Markdown

Valoraciones de estudiantes:

  • 5
  • 4
  • 3
  • 2
  • 1
4.5
262 valoraciones

Lo que aprenderás en este curso:

  • 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.
  • Qué es un lenguaje de marcas y cuáles son los más comunes.
  • Características de Markdown y por qué destaca sobre los demás.
  • Diferentes editores de Markdown.
  • Características de Git y GitHub y qué ventajas aportan en este caso.
  • Conceptos básicos imprescindibles para trabajar con Git y GitHub.
  • Diferentes métodos de publicación que ofrece GitHub.
  • Cómo publicar en GitHub.
  • Aplicar todo lo anterior en una completa práctica.
  • Otros recursos de interés para seguir aprendiendo sobre el tema.

Requisitos del curso

El nivel del taller es básico, se ha pensado como una primera toma de contacto con la elaboración y gestión de documentación técnica. No obstante sería bueno tener algunas nociones básicas de Git y GitHub para seguir mejor el desarrollo de la práctica.

También te puede interesar

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

Git, GitHub y Jekyll

Curso de Git, GitHub y Jekyll

4 horas y 14 minutos · curso

Aprende a crear documentación técnica de forma fácil y profesional utilizando GitHub y Markdown para documentar un proyecto profesionalmente.

  • Herramientas
Metodologías y Herramientas

Qué es GIT y para qué sirve

25 Febrero 2019 Juan Carlos Rubio

Dudas frecuentes

1

¿Cuándo comienza el taller?

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 nuestros planes.

2

¿Cuál es el precio?

En OpenWebinars no vendemos cursos, talleres o laboratorios unitarios.

Tenemos diferentes tipos de suscripciones, 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 ti. Consúltanos aquí.

Cuando hablamos de documentación técnica nos referimos a la documentación que todo producto de software, sea del tipo que sea, siempre debe tener adjunta, y que consiste en toda la información que nos explica cómo funciona un sistema, como está diseñado y con qué fin.

Un documento de este tipo suele contener las características técnicas y la forma de operar del sistema, esta información debe ayudar a entender a las personas que van a trabajar con él.

Este taller está pensando para personas que están comenzando en el mundo de la documentación, ya que es un taller que sirve como introducción a las dos herramientas más populares para creación de documentación técnica, como son el lenguaje Markdown y la web de proyectos GitHub.

El objetivo es conocer los fundamentos en los que se basa la creación de este tipo de documentación y las herramientas recomendadas para ello, además de una serie de consejos e indicaciones que ayudarán a comenzar este desarrollo de una forma correcta.

Aprenderás las diferencias existentes entre los diferentes lenguajes que se pueden utilizar para escribir documentación y las necesidades propias de este tipo de contenidos, lo que nos lleva a los lenguajes de marca. Dentro de los mismos se destaca Markdown, del que verás sus principales características en una guía introductoria que te servirá para comprender su funcionamiento.

Después te explicamos los motivos por los que el uso de Git y GitHub es imprescindible a la hora de crear estos documentos técnicos, y una recopilación de los conceptos o términos básicos que se emplean en los mismos y hay que conocer, como repositorio, readme, rama, clone, commit, pull y muchos más.

A continuación se explican las diferentes opciones que ofrece GitHub para publicar nuestra documentación y una guía rápida sobre cómo realizar una publicación, para finalmente entrar en la parte práctica del taller.

La práctica consiste en crear un nuevo repositorio desde cero y trabajar con el mismo para poder comprobar de una forma más visual todas las operaciones que podemos realizar sobre el mismo, aplicando toda la teoría explicada previamente.

Las cookies nos permiten ofrecer nuestros servicios. Al utilizar nuestros servicios, aceptas el uso que hacemos de las cookies. Más Información.