HACK A BOSS
FormaciónEvaluacionesPerfil
Volver
  • En directo

Markdown: Documentación técnica ágil

4h de clase en directo·HACK A BOSS·Español

Skills que aprenderás

  • Markdown

Convocatorias

Necesitas un plan activo

Para acceder a los cursos en directo necesitas un plan activo. Estamos trabajando para que los planes estén disponibles pronto — ¡mantente atento!

No hay convocatorias abiertas ahora mismo, pero no te pierdas la oportunidad: guarda este curso y te avisamos en cuanto se abra una convocatoria.

Descripción

Objetivos

Temario

Requisitos técnicos

Conocimientos previos

Detalles de la convocatoria

Recursos

No hay recursos disponibles todavía para esta convocatoria

Este curso capacita al participante para crear documentación técnica eficaz utilizando Markdown como lenguaje de marcado ligero. Dirigido a desarrolladores, analistas técnicos y profesionales que necesiten documentar proyectos, APIs o procesos de forma clara y mantenible. Al finalizar, el participante dominará la sintaxis Markdown y será capaz de producir archivos README, guías técnicas y documentación estructurada lista para repositorios y plataformas colaborativas.

Al finalizar el curso, el participante será capaz de:

  • Crear documentos Markdown con estructura básica y contenido técnico
  • Construir un README.md con secciones habituales de documentación
  • Aplicar elementos de formato Markdown para resaltar información técnica
  • Organizar la información en Markdown de forma clara, mantenible y reutilizable
  • Validar documentos Markdown con un editor que ofrezca previsualización
  1. Introducción a Markdown — Qué es Markdown, ventajas frente a HTML, casos de uso habituales, editores y entornos de previsualización
  2. Sintaxis básica — Encabezados, párrafos, saltos de línea, énfasis (negrita, cursiva), listas ordenadas y desordenadas, citas
  3. Enlaces e imágenes — Sintaxis de enlaces inline y por referencia, inserción de imágenes locales y remotas, texto alternativo
  4. Bloques de código y tablas — Código inline y bloques con resaltado de sintaxis, creación y alineación de tablas, uso de caracteres especiales
  5. Estructura de un README.md — Secciones estándar (descripción, instalación, uso, contribución, licencia), badges, tabla de contenidos automática
  6. Organización de documentación técnica — Documentación multi-archivo, estructura de carpetas docs/, convenciones de nombres, enlaces entre documentos
  7. Extensiones y sabores de Markdown — GitHub Flavored Markdown, listas de tareas, menciones, emojis, diferencias entre plataformas (GitLab, Bitbucket)
  8. Buenas prácticas y flujo de trabajo — Mantenibilidad, consistencia estilística, integración con control de versiones, generación de documentación estática
  • Editor de texto con soporte Markdown y previsualización en tiempo real (Visual Studio Code, Obsidian, MarkText o similar)
  • Cuenta en GitHub, GitLab o plataforma similar (opcional, para ejercicios de integración)

Ninguno requerido. Se recomienda familiaridad básica con editores de texto y navegación de archivos en el sistema operativo. Es útil, aunque no imprescindible, haber trabajado con repositorios de código o plataformas como GitHub.