K-Forge / K-Forge/Beetle

Documentación de arquitectura

Open
#216 0 comments 0 reactions 1 assignee Claimed by @iCastro117 View on GitHub
fase-10
Dominant language
Shell
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Qué es esta tarea

Crear la documentación de arquitectura: un documento que explique los componentes del sistema, cómo interactúan, las decisiones de diseño tomadas y por qué se tomaron. Dirigido a desarrolladores que necesiten entender o mantener el sistema.

## Qué se debe hacer

- Crear `docs/arquitectura.md` con:
- Diagrama de componentes (Monitor, Trigger, Detector, Recolector, Sanitizador, Cliente LLM, Informe, Remediador) — puede ser texto o ASCII
- Flujo de datos: de la detección al informe, paso a paso
- Decisiones de diseño con justificación (basadas en la sección 17 del documento de proyecto)
- Justificación de cada componente y por qué existe como pieza separada
- Interfaces entre componentes (qué recibe y qué produce cada uno)
- El documento debe ser comprensible sin acceso al código fuente

## Por qué importa

Sin documentación de arquitectura, cualquier persona nueva en el proyecto (o el propio equipo en 6 meses) tendría que leer todo el código para entender cómo encajan las piezas. Para un producto cerrado, la documentación de arquitectura es especialmente importante porque no hay código fuente público que sirva de referencia (sección 23 del documento de proyecto).

## Criterio de avance

El documento explica todos los componentes, su interacción y las decisiones de diseño. Un desarrollador puede leerlo y entender la estructura del sistema sin ver el código.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.