Add initial README.md with project overview and guidelines

This commit is contained in:
2026-04-09 11:45:30 -06:00
commit 1028e6ecd6

162
README.md Normal file
View File

@@ -0,0 +1,162 @@
# Fidelity AI Workspace
Repositorio diseñado para centralizar contexto, memoria operativa y generación de contenido asistido por IA para el trabajo diario en proyectos de ingeniería.
Este proyecto no almacena código de producto. Su objetivo es organizar conocimiento, decisiones y comunicación para reutilizarlos de forma eficiente con herramientas de IA.
---
## Objetivo
- Centralizar TODO el contexto de un único proyecto activo
- Mantener trazabilidad de decisiones, tickets y comunicación
- Reducir fricción al generar standups, updates y PRs
- Reutilizar conocimiento en prompts de IA
- Capturar aprendizaje continuo (feedback, errores, soluciones)
- Tener una fuente de verdad viva del proyecto
---
## Estructura del proyecto
```
memory/
project.md Contexto principal del proyecto (estado, objetivos, tickets activos)
logs/ Registro diario de trabajo
people/ Stakeholders relevantes (manager, backend, etc)
decisions/ Decisiones técnicas y de producto
prompts/
Templates reutilizables (standup, manager updates, PRs)
scripts/
Automatización (generación de contexto, mensajes, etc)
workflows/
Integraciones con herramientas externas (nexus, opencode)
README.md
```
---
## Flujo de trabajo diario
### Inicio del día
1. Revisar estado del proyecto en `memory/project.md`
2. Revisar último log en `memory/logs/`
3. Generar contexto actualizado del día
---
### Durante el día
Registrar avances en:
```
memory/logs/YYYY-MM-DD.md
```
Formato sugerido:
```
## Trabajo realizado
- ...
## Hallazgos
- ...
## Bloqueos
- ...
```
---
### Fin del día
Actualizar log con:
- Qué se hizo
- Qué se aprendió
- Qué quedó pendiente
---
## Uso con IA
Este repositorio actúa como capa de contexto para herramientas como ChatGPT, Claude u otros modelos.
Ejemplo:
```
Context:
- memory/project.md
- memory/logs/2026-04-09.md
- memory/people/manager.md
Task:
- Generar standup
- Mejorar mensaje para manager
- Crear descripción de PR
```
---
## Prompts disponibles
Ubicados en `prompts/`
Ejemplos:
- standup.md
- manager-update.md
- pr-description.md
---
## Scripts (planeado)
Ejemplos de comandos:
```
generate-context --project apple-pay --days 1
generate-standup
generate-message --manager
```
---
## Buenas prácticas
- Mantener `project.md` siempre actualizado
- Registrar avances diarios en logs
- Documentar decisiones importantes
- Capturar feedback del manager y stakeholders
- Escribir pensando en reutilización para IA
- Evitar duplicar contexto en múltiples archivos
---
## Herramientas
- VSCode como entorno principal
- Basic Memory como base conceptual (estructura en Markdown)
- Nexus Workflow Studio para automatización (opcional)
- opencode para ejecución de workflows y agentes (opcional)
---
## Roadmap
- [ ] Scripts para generación automática de contexto
- [ ] Integración con Mattermost
- [ ] Automatización de standups
- [ ] Sistema de tagging por proyecto
- [ ] Búsqueda semántica
---
## Notas
Este workspace está diseñado para trabajar sobre un único proyecto activo. Si se inicia un nuevo proyecto, se recomienda crear un nuevo workspace o reiniciar la estructura para evitar mezclar contextos.