docs: inicializar estructura de documentacion de agentes
This commit is contained in:
@@ -0,0 +1,17 @@
|
||||
# ideas.md — Ideas y posibilidades
|
||||
|
||||
> Especulativo — "podría ser interesante si...". Sin compromiso.
|
||||
> Cuando una idea se aprueba y se decide que debe hacerse, moverla a `objetivos.md`.
|
||||
> Cuando una idea pasa directamente a ejecución, moverla a `proyecto_memoria.md`.
|
||||
|
||||
---
|
||||
|
||||
## Ideas pendientes
|
||||
|
||||
_(anota aquí las ideas con algo de forma)_
|
||||
|
||||
---
|
||||
|
||||
## Ideas en borrador
|
||||
|
||||
_(anota aquí lo que se te ocurra, sin filtro)_
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,30 @@
|
||||
# objetivos.md — Objetivos del proyecto
|
||||
|
||||
> Cosas que deben implementarse o cumplirse, sin importar cuándo.
|
||||
> Describen QUÉ — no cómo. El cómo va en proyecto_memoria.md cuando se ejecuta.
|
||||
>
|
||||
> Flujo: ideas.md → objetivos.md → (en ejecución) → proyecto_memoria.md
|
||||
|
||||
---
|
||||
|
||||
## Pendientes
|
||||
|
||||
| # | Objetivo | Origen | Prioridad |
|
||||
|---|----------|--------|-----------|
|
||||
| 1 | Definir funcionalidades clave de app_compartir | pablinux | Alta |
|
||||
|
||||
---
|
||||
|
||||
## En curso
|
||||
|
||||
| # | Objetivo | Iniciado |
|
||||
|---|----------|----------|
|
||||
| — | — | — |
|
||||
|
||||
---
|
||||
|
||||
## Completados
|
||||
|
||||
| Fecha | Objetivo | Notas |
|
||||
|---|---|---|
|
||||
| 2026-10-12 | Estructura base de agentes y documentación inicializada | Plantilla Telcotronics |
|
||||
@@ -0,0 +1,19 @@
|
||||
# proyecto_errores.md — Registro de errores
|
||||
|
||||
> Cada error relevante durante desarrollo o producción.
|
||||
|
||||
---
|
||||
|
||||
## Plantilla
|
||||
|
||||
### [FECHA] — [Título corto]
|
||||
- **Síntoma:** [qué fallaba]
|
||||
- **Causa raíz:** [por qué ocurrió]
|
||||
- **Solución:** [qué se cambió]
|
||||
- **Estado:** ✅ Resuelto | 🔧 En curso | ⏳ Pendiente
|
||||
|
||||
---
|
||||
|
||||
## Errores registrados
|
||||
|
||||
_(ninguno aún)_
|
||||
@@ -0,0 +1,35 @@
|
||||
# proyecto_estructura.md — Estructura del proyecto
|
||||
|
||||
> Árbol de archivos, rutas HTTP/API y dependencias entre módulos.
|
||||
> Actualizar al agregar o mover archivos ("actualizar proyecto").
|
||||
|
||||
---
|
||||
|
||||
## Árbol de archivos
|
||||
|
||||
```
|
||||
app_compartir/
|
||||
├── README.md
|
||||
├── agents.md
|
||||
└── .agente/
|
||||
├── infraestructura.md
|
||||
├── proyecto_estructura.md
|
||||
├── proyecto_memoria.md
|
||||
├── proyecto_errores.md
|
||||
├── objetivos.md
|
||||
└── ideas.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Rutas (HTTP / CLI / eventos)
|
||||
|
||||
| Método | Ruta | Handler | Descripción |
|
||||
|---|---|---|---|
|
||||
| [COMPLETAR] | [COMPLETAR] | [COMPLETAR] | [COMPLETAR] |
|
||||
|
||||
---
|
||||
|
||||
## Dependencias entre módulos
|
||||
|
||||
[COMPLETAR]
|
||||
@@ -0,0 +1,32 @@
|
||||
# proyecto_memoria.md — Memoria técnica del proyecto
|
||||
|
||||
> Decisiones tomadas, razonamiento detrás de cada elección y estado actual.
|
||||
> Actualizar con cada decisión técnica relevante.
|
||||
|
||||
---
|
||||
|
||||
## Decisiones técnicas
|
||||
|
||||
| Fecha | Decisión | Razonamiento |
|
||||
|---|---|---|
|
||||
| 2026-10-12 | Inicialización de la estructura estándar de documentación de agentes | Estandarización bajo el ecosistema Telcotronics |
|
||||
|
||||
---
|
||||
|
||||
## Estado actual
|
||||
|
||||
Proyecto recién inicializado. Estructura de documentación base creada. Pendiente definir objetivos específicos, stack detallado y requerimientos.
|
||||
|
||||
---
|
||||
|
||||
## Pendientes
|
||||
|
||||
- [ ] Definir alcance y objetivos del proyecto `app_compartir`
|
||||
- [ ] Inicializar módulo Go (`go mod init app_compartir`)
|
||||
- [ ] Definir arquitectura base
|
||||
|
||||
---
|
||||
|
||||
## Notas y observaciones
|
||||
|
||||
[COMPLETAR]
|
||||
@@ -0,0 +1,25 @@
|
||||
# app_compartir
|
||||
|
||||
Módulo / Servicio del ecosistema Telcotronics en Go.
|
||||
|
||||
---
|
||||
|
||||
## Requisitos
|
||||
|
||||
- Go 1.22+
|
||||
|
||||
## Instalación
|
||||
|
||||
```bash
|
||||
# go mod download
|
||||
```
|
||||
|
||||
## Variables de entorno
|
||||
|
||||
| Variable | Descripción | Default |
|
||||
|---|---|---|
|
||||
| [COMPLETAR] | [COMPLETAR] | [COMPLETAR] |
|
||||
|
||||
## Licencia
|
||||
|
||||
Propiedad de Telcotronics. Todos los derechos reservados.
|
||||
@@ -0,0 +1,130 @@
|
||||
# agents.md — Punto de entrada del proyecto
|
||||
|
||||
> **Reglas:**
|
||||
> - Este archivo es el eslabón más importante. Leerlo siempre antes de cualquier tarea.
|
||||
> - Cada cambio significativo debe reflejarse en este archivo y en los demás archivos del índice.
|
||||
> - Debe ser técnico, claro y detallado para que cualquier humano, agente o IA lo entienda sin explicaciones previas.
|
||||
> - **"carga proyecto"** = Leer este archivo (agents.md) para comprender las reglas, stack, rutas y objetivos del proyecto.
|
||||
> - **"actualizar proyecto"** = hacer commit de los cambios pendientes, actualizar `agents.md` y `.agente/proyecto_estructura.md` con el árbol de archivos actual.
|
||||
|
||||
---
|
||||
|
||||
## Antecedentes
|
||||
|
||||
[COMPLETAR — contexto del problema que resuelve este proyecto, por qué existe dentro del ecosistema Telcotronics]
|
||||
|
||||
---
|
||||
|
||||
## Objetivo general
|
||||
|
||||
[COMPLETAR — qué hace el sistema y cuáles son sus responsabilidades principales]
|
||||
|
||||
1. [COMPLETAR — responsabilidad 1]
|
||||
2. [COMPLETAR — responsabilidad 2]
|
||||
|
||||
---
|
||||
|
||||
## Stack técnico
|
||||
|
||||
| Componente | Tecnología |
|
||||
|---|---|
|
||||
| Lenguaje | Go |
|
||||
| Framework | [COMPLETAR] |
|
||||
| Base de datos | [COMPLETAR] |
|
||||
| [Otros] | [COMPLETAR] |
|
||||
|
||||
---
|
||||
|
||||
## Módulos del sistema
|
||||
|
||||
### 1. [Nombre del módulo]
|
||||
**Estado: ⏳ Pendiente**
|
||||
|
||||
[Descripción del módulo]
|
||||
|
||||
---
|
||||
|
||||
## Infraestructura (referencia rápida)
|
||||
|
||||
> ⚠️ La infraestructura es compartida por todo el ecosistema Telcotronics
|
||||
> (sigma-robot, sigma-web, sigma-c, sigmac_app, CRM, ERP y otros).
|
||||
> La fuente de verdad es **`mcp.telcotronics.net`** — actualmente 🔧 **en mantenimiento**.
|
||||
> Mientras esté en mantenimiento, la fuente alternativa es `/home/pablinux/Projects/infraestructura.md`.
|
||||
> No editar `.agente/infraestructura.md` directamente — ver protocolo de sincronización.
|
||||
|
||||
| Parámetro | Valor |
|
||||
|---|---|
|
||||
| Dominio público | [COMPLETAR] |
|
||||
| Puerto interno | [COMPLETAR] |
|
||||
| Servicio systemd | [COMPLETAR] |
|
||||
| BD principal | [COMPLETAR] |
|
||||
| MCP ecosistema | `mcp.telcotronics.net` 🔧 en mantenimiento |
|
||||
|
||||
> **Correo del ecosistema:** usar `no-reply@sigmac.app` con contraseña `Sigma.2030@`
|
||||
> vía `smtp.sigmac.app:587` (STARTTLS). Desde LAN interna usar `192.168.10.111:587`.
|
||||
> Credenciales disponibles en `.agente/infraestructura.md` — sección servidor-email.
|
||||
|
||||
> Para el detalle completo y datos del ecosistema ver `.agente/infraestructura.md`.
|
||||
|
||||
## Documentos del ecosistema (referencia)
|
||||
|
||||
> Estos documentos viven en `/home/pablinux/Projects/` y son la fuente de verdad del ecosistema.
|
||||
> **No duplicar su contenido aquí** — referenciarlos.
|
||||
|
||||
| Documento | Descripción |
|
||||
|---|---|
|
||||
| `~/Projects/design-system.md` | Sistema de diseño unificado — colores, tipografía, componentes para Flutter / Vue / Java / PHP |
|
||||
| `~/Projects/roadmap.md` | Hoja de ruta estratégica — decisiones técnicas tomadas y pendientes de ejecutar |
|
||||
| `~/Projects/infraestructura.md` | Arquitectura completa de servidores, red, CTs y servicios del ecosistema |
|
||||
| `~/Projects/prompt_actualizacion.md` | Protocolo de actualización — registrar objetivos, documentar sesiones, sincronizar |
|
||||
|
||||
---
|
||||
|
||||
## Variables de entorno (`.env`)
|
||||
|
||||
| Variable | Descripción |
|
||||
|---|---|
|
||||
| [COMPLETAR] | [COMPLETAR] |
|
||||
|
||||
---
|
||||
|
||||
## Migraciones
|
||||
|
||||
Runner: `[COMPLETAR]`
|
||||
|
||||
| Archivo | Tabla principal | Estado |
|
||||
|---|---|---|
|
||||
| — | — | — |
|
||||
|
||||
---
|
||||
|
||||
## Para arrancar en local
|
||||
|
||||
```bash
|
||||
# [COMPLETAR — pasos mínimos para correr el proyecto]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Índice de archivos del proyecto
|
||||
|
||||
```
|
||||
app_compartir/
|
||||
├── README.md
|
||||
├── agents.md # ← LEER PRIMERO
|
||||
└── .agente/
|
||||
├── infraestructura.md # Ecosistema — espejo del global
|
||||
├── proyecto_estructura.md # Árbol de archivos y rutas
|
||||
├── proyecto_memoria.md # Decisiones técnicas e historial
|
||||
├── proyecto_errores.md # Registro de errores
|
||||
├── objetivos.md # Qué debe cumplirse (sin fecha)
|
||||
└── ideas.md # Posibilidades sin compromiso
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Estado global del proyecto
|
||||
|
||||
| Módulo | Estado |
|
||||
|---|---|
|
||||
| [COMPLETAR] | ⏳ Pendiente |
|
||||
Reference in New Issue
Block a user