egutierrez
f3d5ddcddd
Se crean 9 issues para trackear el desarrollo de agentes: Nuevos agentes: - #001 orchestrator: coordinar agentes para proyectos - #002 ci-cd: pipelines de build/test/deploy - #003 testing: tests automatizados Go y React - #004 api-client: gestión de APIs externas - #005 docs-generator: documentación automática Mejoras a existentes: - #006 db-reader: PostgreSQL, migraciones - #007 backend-lib: nuevos módulos shell/app - #008 frontend-lib: versionado, testing - #009 gitea: Actions, templates
72 lines
1.3 KiB
Markdown
72 lines
1.3 KiB
Markdown
# Issue #005: Crear agente docs-generator
|
|
|
|
**Tipo:** feat
|
|
**Prioridad:** baja
|
|
**Estado:** pendiente
|
|
|
|
## Descripción
|
|
|
|
Crear un agente para generar documentación técnica automáticamente desde el código.
|
|
|
|
## Capacidades requeridas
|
|
|
|
### Go
|
|
- [ ] Generar docs desde godoc comments
|
|
- [ ] README.md con ejemplos de uso
|
|
- [ ] API reference
|
|
- [ ] Diagramas de arquitectura (mermaid)
|
|
|
|
### React/TypeScript
|
|
- [ ] Docs desde JSDoc/TSDoc
|
|
- [ ] Props tables para componentes
|
|
- [ ] Storybook docs (ya existe en frontend-lib)
|
|
- [ ] Changelog automático
|
|
|
|
### Proyecto completo
|
|
- [ ] README.md con badges, instalación, uso
|
|
- [ ] CONTRIBUTING.md
|
|
- [ ] CHANGELOG.md (conventional commits)
|
|
- [ ] Arquitectura (diagrama mermaid)
|
|
|
|
## Templates
|
|
|
|
### README.md
|
|
```markdown
|
|
# Proyecto
|
|
|
|
 
|
|
|
|
## Instalación
|
|
## Uso
|
|
## API
|
|
## Desarrollo
|
|
## Licencia
|
|
```
|
|
|
|
### Diagrama arquitectura
|
|
```mermaid
|
|
graph TB
|
|
A[Frontend] --> B[Backend]
|
|
B --> C[Database]
|
|
B --> D[Cache]
|
|
```
|
|
|
|
## Flujo de trabajo
|
|
|
|
```
|
|
Usuario: "Genera documentación para este proyecto"
|
|
|
|
Agente:
|
|
1. Detecta tipo de proyecto
|
|
2. Escanea código y comentarios
|
|
3. Genera README.md
|
|
4. Genera API docs
|
|
5. Genera diagrama de arquitectura
|
|
```
|
|
|
|
## Dependencias
|
|
|
|
- godoc para Go
|
|
- typedoc para TypeScript
|
|
- mermaid para diagramas
|