Lección 4
README y plantillas de incidencias
Redacta README, changelogs y plantillas de incidencias con estructura clara y secciones reutilizables.
Markdown es más valioso cuando sigue formas de documento predecibles.
Estructura de README
Un README open source práctico suele incluir:
# Project name
One-line summary.
## Features
- Feature A
- Feature B
## Quick start
```bash
npm install
npm run dev
Configuration
Explain env vars or config files.
License
MIT
Los lectores escanean README rápidamente. Pon el propósito del proyecto y el inicio rápido cerca del inicio.
## Patrones de CHANGELOG
```markdown
## 1.2.0 - 2026-05-31
### Added
- CSV to JSON converter
### Fixed
- toolbar wrap on mobile
Usa secciones con fecha y tipos de cambio agrupados para que las notas de versión sigan siendo escaneables.
Plantillas de incidencias
Las plantillas de incidencias deben pedir información reproducible:
## Bug report
**Describe the bug**
**Steps to reproduce**
1.
2.
**Expected behavior**
**Environment**
- OS:
- Browser:
Las plantillas reducen idas y venidas haciendo obvios los detalles faltantes.
Conclusión clave
Un buen Markdown de README e incidencias es estructural, no decorativo. Usa encabezados para crear rutas de escaneo y mantén ejemplos cerca de las secciones que los necesitan.
Carga los ejemplos de README o incidencias en la herramienta Vista previa Markdown / Markdown a HTML para comprobar la jerarquía de encabezados antes de publicar.