workspace-v1/06-fase-knowledge-base/README.md
Adrian Flores Cortes 967ab360bb Initial commit: Workspace v1 with 3-layer architecture
Structure:
- control-plane/: Registries, SIMCO directives, CI/CD templates
- projects/: Gamilit, ERP-Suite, Trading-Platform, Betting-Analytics
- shared/: Libs catalog, knowledge-base

Key features:
- Centralized port, domain, database, and service registries
- 23 SIMCO directives + 6 fundamental principles
- NEXUS agent profiles with delegation rules
- Validation scripts for workspace integrity
- Dockerfiles for all services
- Path aliases for quick reference

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-23 00:35:19 -06:00

3.2 KiB

FASE 6: KNOWLEDGE BASE

Estado: Pendiente Duracion Estimada: 1-2 dias Agente Principal: Tech-Leader + Documentation-Agent Dependencias: Fases anteriores completadas


OBJETIVO

Crear repositorio de documentacion centralizada para:

  1. Documentacion tecnica compartida
  2. Guias de desarrollo
  3. Standards y convenciones
  4. Arquitectura del ecosistema
  5. Base para RAG/AI assistance

ESTRUCTURA OBJETIVO

knowledge-base/
|
+-- architecture/
|     +-- overview.md               # Vision general
|     +-- 3-layer-model.md          # Modelo de 3 capas
|     +-- service-descriptor.md     # Standard de descriptors
|     +-- registries.md             # Uso de registries
|
+-- development/
|     +-- setup.md                  # Setup de desarrollo
|     +-- conventions.md            # Convenciones de codigo
|     +-- git-workflow.md           # Workflow de Git
|     +-- code-review.md            # Guidelines de code review
|
+-- operations/
|     +-- docker.md                 # Docker guidelines
|     +-- ci-cd.md                  # CI/CD pipeline
|     +-- deployment.md             # Deployment procedures
|     +-- monitoring.md             # Monitoring setup
|
+-- projects/
|     +-- gamilit/
|     |     +-- overview.md
|     |     +-- architecture.md
|     +-- erp-suite/
|     |     +-- overview.md
|     |     +-- verticales.md
|     +-- trading/
|     +-- betting/
|
+-- api-docs/
|     +-- conventions.md            # API conventions
|     +-- authentication.md         # Auth patterns
|     +-- error-handling.md         # Error responses
|
+-- database/
|     +-- conventions.md            # DB naming conventions
|     +-- migrations.md             # Migration patterns
|     +-- security.md               # DB security
|
+-- troubleshooting/
|     +-- common-issues.md
|     +-- debugging.md
|
+-- glossary.md                     # Terminos y definiciones
+-- README.md

CONTENIDO CLAVE

Architecture Overview

# Arquitectura del Workspace

## Modelo de 3 Capas

1. **Control Plane** (governance)
   - Registries centralizados
   - Sistema de orquestacion (SIMCO/NEXUS)
   - Templates y standards

2. **Product Repos** (codigo)
   - Un repo por producto
   - service.descriptor.yml por servicio
   - Docker compose con redes aisladas

3. **Shared Repos** (compartido)
   - shared-libs: Codigo compartido
   - shared-infra: Infra compartida
   - knowledge-base: Documentacion

Development Setup

# Setup de Desarrollo

## Prerequisitos
- Docker Desktop
- Node.js 18+
- Git

## Pasos
1. Clonar control-plane
2. Ejecutar init-workspace.sh
3. Clonar proyecto deseado
4. Ejecutar init-project.sh
5. docker-compose up

INTEGRACION CON RAG

La knowledge-base esta disenada para ser indexada por sistemas RAG:

# metadata.yml en cada documento
title: "Service Descriptor Standard"
tags: ["architecture", "service-descriptor", "yaml"]
related:
  - "registries.md"
  - "docker.md"
summary: "Define el standard de service.descriptor.yml..."

TAREAS PRINCIPALES

  1. Crear estructura del repo
  2. Migrar documentacion existente
  3. Crear documentacion faltante
  4. Agregar metadata para RAG
  5. Setup de search/indexing

Agente Responsable: Documentation-Agent