Documentación con MarkDown
La documentación es esencial en cualquier proyecto, facilitando la comprensión y el mantenimiento a lo largo del tiempo. Este curso destaca la importancia de documentar proyectos y presenta Markdown como una herramienta eficaz. Aprenderás a estructurar documentos, usar formato básico y avanzado, vincular contenido y aprovechar Visual Studio Code y GitHub para una documentación eficiente y colaborativa.
Objetivos de aprendizaje
- Comprender la importancia de la documentación en proyectos.
- Dominar el uso de Markdown para formatear texto y estructurar documentos.
- Aprender a vincular contenido y crear tablas de contenido.
- Utilizar Visual Studio Code para mejorar el flujo de trabajo con Markdown.
- Explorar GitHub como plataforma para almacenar y compartir documentación.
Temario
-
Introducción a la documentación
- Importancia de la documentación
- Hábitos de documentación
- Documentación pública y compartida
-
Introducción a Markdown
- Origen y uso de Markdown
- Sintaxis básica y convenciones
- Aplicaciones en plataformas como GitHub
-
Formato básico en Markdown
- Encabezados y párrafos
- Texto en negrita y cursiva
- Listas ordenadas y desordenadas
-
Vincular Contenido en Markdown
- Enlaces y referencias
- Tablas de contenido
- Uso de identificadores de anclaje
-
Uso avanzado de Markdown
- Listas de verificación
- Creación y formato de tablas
- Bloques de código y resaltado de sintaxis
-
Markdown en Visual Studio Code
- Instalación y configuración
- Extensiones útiles para Markdown
- Vista previa en tiempo real
-
Documentación en GitHub
- Importancia del archivo README.md
- Secciones recomendadas en un README.md
- Documentación segmentada y enlaces relativos
-
Buenas prácticas de documentación
- Mantenimiento actualizado
- Claridad y concisión
- Inclusión de ejemplos
- Consistencia en estilo y formato
- Fomento de la contribución
Perfil del Estudiante
Este curso está dirigido a una audiencia diversa, incluyendo estudiantes, profesionales y entusiastas de diversas disciplinas que buscan mejorar sus habilidades de documentación en proyectos. Aunque está especialmente diseñado para aquellos que trabajan en proyectos tecnológicos, las técnicas y herramientas presentadas son aplicables a cualquier tipo de proyecto. No se requiere experiencia previa en MarkDown, Visual Studio Code o GitHub, ya que el curso es accesible para personas con diferentes niveles de habilidades técnicas. La audiencia ideal para este curso es aquellos que valoran la importancia de la documentación clara y efectiva en la gestión exitosa de proyectos y el trabajo en equipo.
Conocimientos previos recomendados
Este curso es introductorio y no requiere conocimiento previo. Utiliza Visual Studio Code y Git como herramientas por lo que puede ser beneficioso tener conocimiento de dichas tecnologías.
Recursos técnicos requeridos (Software y hardware a ocupar)
- Computadora con acceso a internet
- Visual Studio Code (instalado)
- Navegador web
Información complementaria
- Los contenidos del curso se encuentran realizados en idioma ESPAÑOL.
- La última actualización de algunos contenidos de este curso fueron realizados el día 18 de abr de 2025.
Comentarios recientes