Skip to content

[Docs] [Experto] README técnico completo del proyecto #10

Description

@Andres-Torrez

Descripción

README técnico completo del repositorio que documenta todo el proyecto:
arquitectura, stack, instalación, endpoints, esquema de BD, métricas
del modelo, estructura de carpetas y estado real del proyecto.

Tareas

  • Descripción del proyecto y problema que resuelve
  • Diagrama de arquitectura como imagen
  • Stack tecnológico con justificación de cada elección
  • Estructura completa de carpetas explicada línea a línea
  • Comandos exactos de instalación y arranque (backend + frontend)
  • Endpoints de la API con ejemplo de respuesta JSON real
  • Esquema de base de datos (brands, videos, detections)
  • Instrucciones de entrenamiento con los 3 perfiles (fast/medium/full)
  • Métricas del modelo por clase (15 marcas)
  • Estado real honesto: qué funciona vs qué está pendiente
  • Referencias a dataset (Roboflow) y modelo (Hugging Face)
  • Tabla del equipo con roles

Criterios de aceptación

  • Cualquier evaluador puede entender el proyecto leyendo solo el README
  • Los comandos de instalación son exactos y reproducibles
  • El estado real del proyecto es honesto — nada descrito como
    funcionando sin haberlo probado con evidencia real

Rama: docs/readme-inicial
Sprint: S4 · Experto
Labels: docs sprint-4-experto

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions