Documentación del Proyecto - Sistema de Posturografía EPPA¶
Esta carpeta contiene toda la documentación del proyecto organizada por categoría.
Estructura¶
docs/
├── api/ # Documentación de la API
│ ├── API_REFERENCE.md # Referencia completa de endpoints
│ ├── README_API.md # Guía de la API
│ ├── API_INTEGRATION_COMPLETE.md # Estado de integración
│ └── VALIDATION_SUMMARY.md # Resumen de validación
│
├── testing/ # Documentación de pruebas
│ ├── TEST_CASES.md # Casos de prueba detallados
│ ├── TESTING_SUMMARY.md # Resumen de testing
│ ├── QUICK_START_TESTING.md # Guía rápida de testing
│ ├── README_TESTING.md # Índice de testing
│ └── ANALISIS_COMPLETADO.txt # Análisis completado
│
├── guides/ # Guías de usuario
│ ├── MANUAL_DE_USO.md # Manual de usuario completo
│ └── PROJECT_STATUS.md # Estado del proyecto
│
└── README.md # Este archivo
Enlaces Rápidos¶
Para Desarrolladores¶
- API Reference - Documentación completa de todos los endpoints
- Testing Guide - Guía completa de testing
- Test Cases - Casos de prueba con coordenadas MATLAB
Para Usuarios¶
- Manual de Uso - Guía completa para usar el sistema
- Project Status - Estado actual del proyecto
Para QA/Testing¶
- Quick Start Testing - Empezar con testing rápidamente
- Testing Summary - Resumen ejecutivo de testing
- Validation Summary - Validación vs MATLAB
Documentación Adicional¶
En matlab_validation/docs/¶
- Documentación específica de validación MATLAB
- Guías de instalación y uso de scripts de validación
En datos/¶
- README con estructura de datos
- Información sobre archivos .mat y resultados
Contribuir a la Documentación¶
Al agregar nueva documentación:
1. Colocarla en el subdirectorio apropiado (api/, testing/, o guides/)
2. Actualizar este README con el nuevo enlace
3. Usar formato Markdown estándar
4. Incluir ejemplos de código cuando sea apropiado
Notas¶
- Toda la documentación está en español
- Los ejemplos de código incluyen comentarios explicativos
- Las guías incluyen capturas de pantalla cuando es necesario