Añadir Home
commit
70f3a7ad60
|
@ -0,0 +1,67 @@
|
|||
# Nombre de la aplicacion: NetDocsForLLM
|
||||
|
||||
# Especificación: Aplicación para Documentación de Librerías .NET para LLMs
|
||||
|
||||
## Objetivo
|
||||
|
||||
Aplicación que genera documentación estructurada de librerías .NET para consumo por modelos LLM.
|
||||
|
||||
## Tecnologías principales
|
||||
|
||||
- **WPF** para interfaz de usuario
|
||||
- **CommunityToolkit.Mvvm** para arquitectura MVVM
|
||||
- **DocFX** como motor de extracción de documentación
|
||||
- **Ookii.Dialogs.Wpf** para diálogos de selección de archivos
|
||||
- **NewtonSoft.Json** para serialización/exportación
|
||||
- **Extended.Wpf.Toolkit** para controles avanzados de UI
|
||||
|
||||
## Funcionalidades clave
|
||||
|
||||
1. **Selección de librerías**
|
||||
|
||||
- Diálogo para seleccionar archivos DLL mediante Ookii.Dialogs
|
||||
- Validación de ensamblados .NET
|
||||
2. **Análisis y extracción**
|
||||
|
||||
- Integración con DocFX para extracción de metadatos y comentarios XML
|
||||
- Procesamiento de estructura de clases, métodos, propiedades
|
||||
- Extracción de ejemplos si están disponibles en documentación
|
||||
3. **Generación de documentación**
|
||||
|
||||
- Transformación de salida DocFX a formato JSON optimizado para LLMs
|
||||
- Estructuración jerárquica de namespaces, clases y miembros
|
||||
- Preservación de comentarios y relaciones
|
||||
4. **Configuración de formato**
|
||||
|
||||
- Opciones de nivel de detalle (básico/detallado)
|
||||
- Configuración de elementos a incluir/excluir
|
||||
- Personalización de formato de salida
|
||||
5. **Exportación y compartición**
|
||||
|
||||
- Exportación a JSON/YAML para consumo por LLMs
|
||||
- Vista previa en la aplicación
|
||||
- Opción para copiar al portapapeles
|
||||
|
||||
## Flujo de usuario
|
||||
|
||||
1. Lanzar aplicación
|
||||
2. Seleccionar archivo(s) DLL
|
||||
3. Configurar opciones (opcional)
|
||||
4. Generar documentación
|
||||
5. Previsualizar resultado
|
||||
6. Exportar o copiar documentación
|
||||
|
||||
## Estructura arquitectónica (MVVM)
|
||||
|
||||
- **Modelos**: Representación de ensamblados y documentación
|
||||
- **ViewModels**: Lógica de selección y generación
|
||||
- **Vistas**: Interfaz WPF con controles avanzados
|
||||
|
||||
## Formato de salida
|
||||
|
||||
Documentación JSON estructurada con:
|
||||
|
||||
- Jerarquía de namespaces y tipos
|
||||
- Métodos con parámetros y retornos
|
||||
- Clases y Estructuras
|
||||
- Comentarios XML procesados
|
Loading…
Reference in New Issue