Documentación técnica con Markdown

Curso de iniciación al uso de Markdown orientado a profesionales técnicos que escriben documentación de proyectos —READMEs, guías de instalación, referencias de API— y necesitan hacerlo con el formato correcto sin depender de editores visuales. El curso cubre los elementos esenciales de la sintaxis: encabezados, listas, bloques de código con resaltado de lenguaje, énfasis, tablas y enlaces; la estructura habitual de un README.md con las secciones que todo proyecto de software debe tener; los criterios para elegir el marcado adecuado a cada tipo de información técnica; y el uso de la vista previa del editor para detectar y corregir errores de renderizado antes de publicar. Al finalizar, el participante será capaz de escribir documentación técnica en Markdown que se renderice correctamente en GitHub, GitLab o cualquier plataforma compatible con CommonMark, con una estructura clara y un formato consistente.

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 formato Markdown para resaltar información técnica
• Validar en previsualización que la sintaxis Markdown renderiza correctamente

1. Sintaxis básica de Markdown Encabezados con # y jerarquía de secciones; listas ordenadas y no ordenadas; énfasis con negrita y cursiva; bloques de código delimitados con triple acento grave y especificación del lenguaje para resaltado de sintaxis; código inline con acento grave simple; propósito de cada elemento y cuándo usarlo en un documento técnico

2. Estructura de un README.md Secciones habituales de un proyecto de software: nombre y descripción, requisitos previos, instalación, uso, licencia y referencias; sintaxis de enlaces: [texto](url) para recursos externos e internos al repositorio; criterios para decidir qué información va en cada sección; plantilla reutilizable como punto de partida para nuevos proyectos

3. Formato técnico: código, tablas y énfasis Código inline para parámetros, rutas, nombres de comandos y variables dentro del texto; bloque de código para fragmentos de varias líneas, ficheros de configuración y salidas de terminal; tablas Markdown: fila de encabezado, fila separadora obligatoria con guiones y filas de datos; negrita y cursiva para énfasis semántico, no para destacar código; blockquote para advertencias o notas contextuales

4. Validación con vista previa del editor Vista previa integrada en VS Code: cómo abrir y usar la vista en paralelo al archivo fuente; errores frecuentes detectables en previsualización: encabezado sin espacio tras #, bloque de código sin triple delimitador, tabla sin fila separadora, enlace malformado; proceso iterativo de corrección; diferencia entre validación visual del renderizado y validación funcional del contenido técnico

• VS Code con la previsualización de Markdown integrada (sin extensiones adicionales)
• Cuenta en GitHub o GitLab para verificar el renderizado de archivos Markdown en el repositorio
• Git instalado para los ejercicios de commit y push de documentación
• Terminal: bash, zsh o PowerShell

Ninguno requerido. El curso está orientado a profesionales técnicos con familiaridad básica con un editor de texto y el sistema de ficheros. No es necesario conocer ningún lenguaje de programación ni haber trabajado con sistemas de documentación anteriormente.