From d5030bdc0d9f06bf0347cf07cca46a6c3a0b4c65 Mon Sep 17 00:00:00 2001 From: Hermes Date: Wed, 28 Oct 2026 13:26:37 +0000 Subject: [PATCH] feat: estructura del repositorio para reportes por tipo MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - README principal en español con guía de uso - .gitignore para SO, editores, Python/Node y salidas - plantillas/plantilla-reporte.md con frontmatter - reportes/{semanal,mensual,hito,final} con README simple - assets/ para imágenes embebidas --- .gitignore | 33 ++++++++++++++++++++++++++ README.md | 42 ++++++++++++++++++++++++++++++++- assets/README.md | 4 ++++ plantillas/plantilla-reporte.md | 26 ++++++++++++++++++++ reportes/final/README.md | 6 +++++ reportes/hito/README.md | 7 ++++++ reportes/mensual/README.md | 6 +++++ reportes/semanal/README.md | 6 +++++ 8 files changed, 129 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 assets/README.md create mode 100644 plantillas/plantilla-reporte.md create mode 100644 reportes/final/README.md create mode 100644 reportes/hito/README.md create mode 100644 reportes/mensual/README.md create mode 100644 reportes/semanal/README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9843a24 --- /dev/null +++ b/.gitignore @@ -0,0 +1,33 @@ +# Sistemas operativos +.DS_Store +Thumbs.db +desktop.ini + +# Editores e IDEs +.vscode/ +.idea/ +*.swp +*~ + +# Python +__pycache__/ +*.py[cod] +.venv/ +venv/ +.pytest_cache/ +.mypy_cache/ + +# Node +node_modules/ + +# Salidas y archivos temporales de generación de reportes +*.tmp +*.bak +.cache/ +build/ +dist/ +output/ + +# Binarios grandes que no deben versionarse +*.zip +*.tar.gz diff --git a/README.md b/README.md index 03d47d3..d113964 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ -# reports +# Reportes +Repositorio central de reportes del equipo. Cada reporte se genera a partir de una +plantilla y se archiva según su tipo, de modo que el historial quede ordenado y sea +fácil encontrar versiones anteriores. + +## Estructura + +```text +. +├── README.md # esta guía +├── .gitignore # archivos ignorados por Git +├── plantillas/ # plantillas para crear nuevos reportes +│ └── plantilla-reporte.md +├── reportes/ # reportes archivados, uno por carpeta +│ ├── semanal/ +│ ├── mensual/ +│ ├── hito/ +│ └── final/ +└── assets/ # imágenes y binarios embebidos en los reportes +``` + +## Tipos de reporte + +| Tipo | Carpeta | Descripción | +| --- | --- | --- | +| Semanal | `reportes/semanal/` | Avance de la semana: tareas, bloqueos, próximos pasos. | +| Mensual | `reportes/mensual/` | Resumen del mes con métricas y estado general. | +| Hito | `reportes/hito/` | Cierre de un hito o entregable del proyecto. | +| Final | `reportes/final/` | Informe final del proyecto. | + +## Cómo agregar un reporte + +1. Copia `plantillas/plantilla-reporte.md` a la carpeta de su tipo. +2. Nombra el archivo `AAAA-MM-DD-.md`, por ejemplo `2026-10-28-semana-44.md`. +3. Completa la tabla de metadatos (frontmatter) y el contenido. +4. Guarda las imágenes en `assets/` y referéncialas desde el reporte. + +## Agregar un nuevo tipo de reporte + +Crea una carpeta en `reportes//` con su propio `README.md` describiendo +el formato, y copia la carpeta de un tipo existente como base. diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 0000000..1ea5593 --- /dev/null +++ b/assets/README.md @@ -0,0 +1,4 @@ +# Assets + +Imágenes, diagramas y binarios embebidos (`![[...]]`) desde los reportes. +Organiza por reporte o fecha cuando haya muchos archivos. diff --git a/plantillas/plantilla-reporte.md b/plantillas/plantilla-reporte.md new file mode 100644 index 0000000..782ae6b --- /dev/null +++ b/plantillas/plantilla-reporte.md @@ -0,0 +1,26 @@ +--- +titulo: "Título del reporte" +tipo: semanal # semanal | mensual | hito | final +fecha: AAAA-MM-DD +autor: Cristhian +estado: borrador # borrador | revisado | entregado +--- + +# Título del reporte + +## Resumen + +Un párrafo con lo esencial del periodo. + +## Avance + +- Tarea o resultado 1. +- Tarea o resultado 2. + +## Bloqueos y riesgos + +- Nada bloqueante, o descripción del bloqueo. + +## Próximos pasos + +- [ ] Acción siguiente. diff --git a/reportes/final/README.md b/reportes/final/README.md new file mode 100644 index 0000000..ae6edb7 --- /dev/null +++ b/reportes/final/README.md @@ -0,0 +1,6 @@ +# Reportes finales + +Informe final del proyecto: resultados completos, conclusiones y lecciones aprendidas. + +- Nombre de archivo: `AAAA-MM-DD-informe-final.md`. +- Plantilla base: `../../plantillas/plantilla-reporte.md`. diff --git a/reportes/hito/README.md b/reportes/hito/README.md new file mode 100644 index 0000000..9e474b4 --- /dev/null +++ b/reportes/hito/README.md @@ -0,0 +1,7 @@ +# Reportes de hito + +Cierre de un hito o entregable del proyecto: objetivos cumplidos, entregables y +evidencia asociada. + +- Nombre de archivo: `AAAA-MM-DD-hito-.md`. +- Plantilla base: `../../plantillas/plantilla-reporte.md`. diff --git a/reportes/mensual/README.md b/reportes/mensual/README.md new file mode 100644 index 0000000..c394d3d --- /dev/null +++ b/reportes/mensual/README.md @@ -0,0 +1,6 @@ +# Reportes mensuales + +Resumen mensual con métricas, estado general del proyecto y decisiones tomadas. + +- Nombre de archivo: `AAAA-MM-.md` (primer día del mes). +- Plantilla base: `../../plantillas/plantilla-reporte.md`. diff --git a/reportes/semanal/README.md b/reportes/semanal/README.md new file mode 100644 index 0000000..7bf4261 --- /dev/null +++ b/reportes/semanal/README.md @@ -0,0 +1,6 @@ +# Reportes semanales + +Reportes de avance de una semana: tareas realizadas, bloqueos y próximos pasos. + +- Nombre de archivo: `AAAA-MM-DD-.md` (fecha del lunes de la semana). +- Plantilla base: `../../plantillas/plantilla-reporte.md`.