📄 Plantilla de Documentación de Proyectos ¶

Una estructura de archivos .md lista para reutilizar en cualquier proyecto nuevo. Clona, copia y empieza a documentar sin partir de cero.

Este repositorio reúne los documentos Markdown más comunes de un proyecto bien documentado, cada uno con su estructura y ejemplos. La idea es tener siempre a la mano una base consistente, en lugar de reinventar la documentación en cada proyecto.

¿Qué incluye? ¶

Todos los archivos-plantilla están en la carpeta template/:

Archivo	Para qué sirve
README.md	Puerta de entrada del proyecto: qué es y cómo arrancar
CHANGELOG.md	Historial de versiones (formato Keep a Changelog)
ROADMAP.md	Planes a futuro, por fases o trimestres
CONTRIBUTING.md	Cómo contribuir: ramas, commits, PRs
CLAUDE.md	Contexto para Claude Code
SECURITY.md	Cómo reportar vulnerabilidades
CODE_OF_CONDUCT.md	Normas de la comunidad
LICENSE	Licencia MIT
docs/VISION.md	Visión, problema y solución
docs/ARCHITECTURE.md	Diagrama y decisiones técnicas
docs/FEATURES.md	Funcionalidades en detalle
docs/INSTALL.md	Instalación paso a paso
docs/API.md	Referencia de la API
docs/adr/	Architecture Decision Records (una por decisión)

Cómo usarla ¶

Opción A — Copiar a un proyecto nuevo ¶

# Copia el contenido de template/ a tu proyecto
cp -r template/. mi-proyecto/
cd mi-proyecto

# Borra los archivos que no necesites (ver tabla "Qué incluir" abajo)
# Rellena los <placeholders> de cada archivo

git init
git add .
git commit -m "docs: estructura inicial de documentación"

Opción B — Usar este repo como Template repository en GitHub ¶

1. Sube este repositorio a tu cuenta de GitHub (ver comandos abajo).
2. En Settings → General, activa la casilla Template repository.
3. A partir de ahí, el botón “Use this template” genera proyectos nuevos con toda esta estructura en un clic.

git init
git add .
git commit -m "docs: plantilla de documentación de proyectos"
git remote add origin https://github.com/TU_USUARIO/docs-template
git branch -M main
git push -u origin main

Opción C — Instalarla como skill de Claude Code ¶

El repo incluye la carpeta docs-template-skill/, una skill lista para Claude Code. Una vez instalada, basta con pedirle a Claude algo como “documenta este proyecto” o “crea la estructura de docs” y aplicará la plantilla automáticamente, rellenando los archivos con el contexto real del proyecto.

El archivo docs-template-skill.skill empaquetado se instala desde la interfaz de skills de Claude.

¿Qué incluir según el proyecto? ¶

No todos los proyectos necesitan todos los archivos. Usa esto como guía y borra lo que no aplique:

Archivo	Personal	Open source	Equipo
README	✅	✅	✅
CHANGELOG	recomendado	✅	✅
CLAUDE.md	si usas IA	opcional	✅
CONTRIBUTING	❌	✅	✅
SECURITY	❌	✅	✅
CODE_OF_CONDUCT	❌	✅	opcional
ROADMAP	opcional	recomendado	✅
docs/ADR	opcional	recomendado	✅

Convenciones de los .md ¶

• Un solo # H1 por archivo (el título); el resto ## y ###.
• Una frase por línea o líneas cortas → diffs limpios en Git.
• Enlaces relativos entre documentos, no URLs absolutas.
• Bloques de código siempre con su lenguaje (```bash, ```js).
• Fechas en formato ISO (2026-01-15).

Licencia ¶

Usa esta plantilla libremente. El archivo template/LICENSE trae una licencia MIT lista para tus proyectos.