feat: estructura del repositorio para reportes por tipo
- 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
This commit is contained in:
+33
@@ -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
|
||||||
@@ -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-<slug>.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/<nuevo-tipo>/` con su propio `README.md` describiendo
|
||||||
|
el formato, y copia la carpeta de un tipo existente como base.
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# Assets
|
||||||
|
|
||||||
|
Imágenes, diagramas y binarios embebidos (`![[...]]`) desde los reportes.
|
||||||
|
Organiza por reporte o fecha cuando haya muchos archivos.
|
||||||
@@ -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.
|
||||||
@@ -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`.
|
||||||
@@ -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-<n>.md`.
|
||||||
|
- Plantilla base: `../../plantillas/plantilla-reporte.md`.
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
# Reportes mensuales
|
||||||
|
|
||||||
|
Resumen mensual con métricas, estado general del proyecto y decisiones tomadas.
|
||||||
|
|
||||||
|
- Nombre de archivo: `AAAA-MM-<slug>.md` (primer día del mes).
|
||||||
|
- Plantilla base: `../../plantillas/plantilla-reporte.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-<slug>.md` (fecha del lunes de la semana).
|
||||||
|
- Plantilla base: `../../plantillas/plantilla-reporte.md`.
|
||||||
Reference in New Issue
Block a user