MD
Guía para crear manuales en formato Markdown
CUANDO CADA MEGA CUESTA, CADA BIT CUENTA
⬇️ Descargar en Markdown Tema

Guía para crear manuales en formato Markdown para contextos de baja conectividad

CUANDO CADA MEGA CUESTA, CADA BIT CUENTA

Para formadores de Latinoamérica · Versión 1.0 · Licencia: CC BY-SA

Esta guía está pensada para formadores, facilitadores, organizaciones y colectivos en Latinoamérica que necesitan crear materiales educativos que funcionen en contextos donde el acceso a internet es limitado, inestable o costoso. Ayuda a diseñar manuales ligeros, claros y totalmente funcionales sin conexión.

Hablamos de situaciones donde:

  • el internet móvil es muy caro,
  • los datos móviles (“cuac”) se agotan rápido,
  • hay señal débil o nula,
  • se trabaja con dispositivos de baja gama,
  • el acceso a computadoras o software especializado es limitado.

Aunque varios ejemplos se basan en seguridad digital y física, la metodología aplica a cualquier temática: educación comunitaria, salud, cuidados, trabajo organizativo, tecnología, talleres participativos, etc.

Contenido para formadores

Este bloque incluye todo lo necesario para diseñar, crear, estructurar y optimizar manuales en formato Markdown para contextos con conectividad limitada.

2. ¿Por qué usar Markdown para manuales en Latinoamérica?

2.1 Súper ligero y fácil de compartir

Los archivos .md suelen pesar entre 20 KB y 70 KB, incluso con contenido extenso. Esto facilita compartirlos por:

  • WhatsApp/Signal
  • Bluetooth,
  • memorias USB o tarjetas SD,
  • redes comunitarias locales.
  • etc

En contraste, un PDF equivalente puede pesar 5–20 MB, lo cual es prohibitivo con datos móviles limitados.

2.2 Funciona en la mayoría de dispositivos

Un archivo Markdown puede abrirse con:

  • Bloc de notas / Notepad,
  • editores básicos de texto en Android,
  • VSCode Portable,
  • navegadores web (arrastrando el archivo).

2.3 Adaptable por comunidades locales

Cualquier persona puede traducir, ajustar, ampliar, recortar o reestructurar el contenido sin necesidad de software pesado o licencias de pago.

2.4 Se convierte en otros formatos cuando haga falta

A partir del mismo archivo .md es posible generar:

  • HTML navegable offline,
  • PDF listo para imprimir,
  • EPUB, DOCX o presentaciones.

2.5 Más seguro que otros formatos

Los archivos Markdown casi no contienen metadatos, no ejecutan macros y no cargan elementos externos, por lo que tienden a ser más seguros frente a amenazas digitales que otros formatos más complejos.

3. Cómo manejar imágenes sin hacer pesado tu paquete

El texto pesa poco; las imágenes no. Esta sección es clave para mantener tus manuales ligeros.

3.1 Usa SVG para diagramas

Los SVG son ideales para diagramas como:

  • flujos de amenazas,
  • mapas de riesgo,
  • esquemas de comunicación segura,
  • diagramas de toma de decisiones.
  • etc.

Ejemplo de referencia desde Markdown:

![Flujo de amenazas](imagenes/flujo-amenazas.svg)

3.2 Usa PNG/JPG optimizados para fotos y capturas

Para fotos o capturas de pantalla (por ejemplo, de configuraciones de un teléfono, ejemplos de botiquines o herramientas físicas), lo habitual será usar PNG o JPG.

Cómo optimizar PNG/JPG:
  • Reducir a 800–1200 px de ancho.
  • Comprimir con herramientas como TinyPNG, ImageOptim o Squoosh.
  • Convertir PNG a JPG cuando no haya transparencias ni texto pequeño.
  • Mantener idealmente entre 40 KB y 250 KB por imagen.
  • Evitar fotos tomadas en “modo alta resolución” sin necesidad.

Ejemplo de referencia desde Markdown:

![Pantalla de configuración](imagenes/configuracion-basica.jpg)

3.3 Evita incrustar imágenes como Base64

Incrustar imágenes usando datos Base64 dentro del Markdown (por ejemplo: data:image/png;base64,...) solo se recomienda en casos muy específicos, cuando necesitas un único archivo autosuficiente.

Desventajas: hace enorme el archivo .md, complica su edición y dificulta el control de versiones.

3.4 Ejemplo de diagrama en SVG

A continuación se muestra un ejemplo de diagrama de flujo de la información usando SVG. La ruta es: Persona → Computadora → Módem → Centralita → Cableado → ISP → Servicio en la nube.

Cómo se referencia este SVG desde Markdown:

![Diagrama del flujo de la información](imagenes/flujo-informacion.svg)

Ejemplo renderizado inline:

Flujo de la información: Persona a Servicio en la nube Persona Computadora Módem Centralita Cableado ISP Servicio en la nube

4. Estructura recomendada de un paquete offline

Esta estructura funciona para casi cualquier tipo de manual y facilita la navegación, traducción y adaptación por parte de otras personas. 

manual-nombre/
├── 00-introduccion.md
├── 01-conceptos-basicos.md
├── 02-paso-a-paso.md
├── 03-ejemplos-practicos.md
├── 04-actividades.md   (opcional)
├── glosario.md
└── imagenes/
      ├── diagrama-01.svg
      ├── captura-01.jpg
      └── ...

Mantener nombres claros y prefijos numéricos ayuda a que el orden sea evidente incluso en dispositivos de baja gama que no siempre muestran vistas complejas de carpetas.

5. Plantilla oficial de manual en Markdown

Esta plantilla está lista para copiar/pegar cuando quieras crear un nuevo manual. Puedes adaptarla según tu temática. 

# Título del documento  
_Subtítulo o propósito del manual_

Autor/a:  
Organización (si aplica):  
Versión:  
Última actualización:  

---

## 1. Objetivo

Describe qué aprenderá la persona y qué necesidad concreta resuelve este manual.

---

## 2. Perfil de la persona lectora

- Nivel técnico o educativo  
- Contexto territorial  
- Limitaciones (datos móviles caros, dispositivos de baja gama, sin señal estable)  
- Tiempo estimado para completar la guía  

---

## 3. Requisitos o materiales

- Dispositivo (teléfono/computadora)  
- Carpeta con imágenes (incluida en el paquete)  
- Conocimientos previos básicos (si aplica)

---

## 4. Paso a paso

### 4.1 Paso 1 — Nombre del paso  
1. Explicación breve.  
2. Lista de acciones.  
3. Imagen si ayuda:

   ![Ejemplo de diagrama](imagenes/diagrama-01.svg)

> 💡 Consejo práctico.

---

### 4.2 Paso 2 — Nombre del paso  
1. Descripción.  
2. Instrucciones claras.  
3. Advertencia si aplica:

> ⚠️ Advertencia: explica un riesgo real o error común.

---

## 5. Errores comunes + soluciones

- **Error 1:** descripción.  
  **Solución:** pasos claros.

---

## 6. Glosario

- **Término 1:** explicación sencilla.  
- **Término 2:** explicación sencilla.

---

## 7. Recursos útiles cuando sí haya internet

(Enlaces opcionales.)

6. Buenas prácticas para formadores

  • Lenguaje directo y claro: escribe pensando en personas que no podrán buscar explicaciones adicionales en internet.
  • Imágenes que aportan: si una imagen no mejora la comprensión, no es necesaria.
  • Explica el porqué: decir solo “haz clic aquí” no genera criterio.
  • Evita dependencias en línea: el manual debe funcionar por completo sin conexión.
  • Prueba en dispositivos de baja gama: celulares sencillos y laptops antiguas.
  • Revisa con personas no expertas: si lo entienden sin ayuda, tu manual está bien diseñado.

7. Flujo de trabajo recomendado

  1. Crear un borrador inicial en .md.
  2. Preparar imágenes SVG y JPG/PNG optimizadas.
  3. Ordenar carpetas y archivos con nombres claros.
  4. Realizar una revisión técnica y pedagógica.
  5. Probar el manual con alguien de la comunidad.
  6. Exportar a PDF/HTML si se requiere para impresión u otros usos.
  7. Empaquetar TODO en un archivo .zip.
  8. Compartir el .zip por Signal, WhatsApp, Bluetooth, tarjeta SD u otros medios disponibles.
Recomendación: usar .zip ayuda a mantener intacta la estructura de carpetas, las rutas de imágenes y reduce el peso del paquete para enviarlo más fácilmente.

8. Checklist final antes de compartir

  • ☐ ¿Los .md abren correctamente en celular y computadora?
  • ☐ ¿Las imágenes se muestran sin conexión a internet?
  • ☐ ¿El archivo .zip pesa poco para compartirlo?
  • ☐ ¿El lenguaje es claro para el público objetivo?
  • ☐ ¿El paso a paso funciona completamente offline?
  • ☐ ¿Incluye advertencias importantes si aplica (seguridad digital/física)?
  • ☐ ¿Incluye un glosario básico?

9. Tutorial básico de Markdown (para formadores)

A continuación, algunos de los marcados más comunes que usarás al crear tus manuales en Markdown, con el código y un ejemplo de cómo se ve al final.

9.1 Encabezados

Markdown:

# Título
## Sección
### Sub-sección

Renderizado:

Título (nivel 1)
Sección (nivel 2)
Sub-sección (nivel 3)

9.2 Negritas y cursivas

Markdown:

**negritas**
*cursivas*

Renderizado:

negritas
cursivas

9.3 Listas

Listas

Markdown:

- elemento
- elemento

Renderizado:

  • elemento
  • elemento

Listas numeradas

Markdown:

1. paso uno
2. paso dos

Renderizado:

  1. paso uno
  2. paso dos

9.4 Enlaces

Markdown:

[Guía oficial de Markdown](https://www.markdownguide.org/)

Renderizado:

Guía oficial de Markdown

9.5 Imágenes

Markdown:

![Texto alternativo](imagenes/ejemplo.png)

Renderizado:

(Se mostrará la imagen imagenes/ejemplo.png con el texto alternativo.)

9.6 Citas o notas

Markdown:

> Nota importante o recomendación

Renderizado:

Nota importante o recomendación

9.7 Código en línea

Markdown:

`comando`

Renderizado:

comando

9.8 Bloques de código largos

Markdown:

```
tu texto aquí
```

Esto se mostrará como un bloque de código, similar a los ejemplos que ves en esta guía.

9.9 Tablas

Markdown:

| Nombre | Descripción |
|--------|-------------|
| Paso 1 | Revisar     |
| Paso 2 | Configurar  |

Renderizado:

Nombre Descripción
Paso 1 Revisar
Paso 2 Configurar

9.10 Enlaces oficiales recomendados

Contenido para usuarios finales

Este bloque se puede incluir al final de cada manual. Está pensado para las personas que reciben el paquete offline y necesitan saber cómo usarlo.

10. Cómo abrir esta guía

Puedes abrir los archivos .md con:

  • Bloc de notas / Notepad,
  • aplicaciones básicas de texto en Android,
  • navegadores web,
  • VSCode Portable (si viene incluido).

No necesitas conexión a internet para leer el contenido.

11. Cómo navegar el manual

  • Empieza abriendo el archivo 00-introduccion.md.
  • Sigue los archivos numerados (01-..., 02-...) en el orden en que aparecen.
  • Cuando el texto lo indique, abre las imágenes desde la carpeta imagenes/.

12. Cómo compartirlo con otras personas

Puedes compartir el archivo .zip de la guía usando:

  • Bluetooth,
  • cables USB,
  • tarjetas SD,
  • WhatsApp,
  • Signal,
  • WiFi Direct u otros medios locales.

El contenido seguirá funcionando aunque no haya señal ni datos móviles.

13. Qué hacer si algo no se entiende

  • Anota tu duda en un cuaderno o en el propio archivo (si sabes editar).
  • Incluye el nombre del archivo y el paso donde te perdiste.
  • Pide apoyo a la persona o equipo que te entregó la guía.

14. Mantén la guía segura

  • No subas la guía a redes sociales sin permiso.
  • No abras archivos adicionales que no reconozcas dentro del paquete.
  • Evita modificar archivos si no sabes para qué sirven.

Cuidar estos materiales también ayuda a proteger a las personas y procesos que dependen de ellos.