136 lines
3.1 KiB
Markdown
136 lines
3.1 KiB
Markdown
# Guía para Documentar la Aplicación EFC
|
|
|
|
## Metodología Recomendada
|
|
|
|
### 1. CAPTURA DE PANTALLAS SISTEMÁTICA
|
|
|
|
#### Preparación:
|
|
- Usar datos de prueba consistentes
|
|
- Configurar resoluciones estándar (1920x1080, 1366x768)
|
|
- Usar navegadores principales (Chrome, Firefox, Safari)
|
|
- Preparar diferentes roles de usuario
|
|
|
|
#### Herramientas recomendadas:
|
|
- **Snagit** - Para capturas profesionales con anotaciones
|
|
- **Loom** - Para videos explicativos
|
|
- **Figma** - Para crear diagramas de flujo
|
|
- **Draw.io** - Para diagramas técnicos
|
|
|
|
### 2. ESTRUCTURA DE CADA SECCIÓN
|
|
|
|
Para cada funcionalidad documentar:
|
|
|
|
1. **Objetivo** - ¿Para qué sirve?
|
|
2. **Prerrequisitos** - ¿Qué se necesita antes?
|
|
3. **Paso a paso** - Procedimiento detallado
|
|
4. **Screenshots** - Pantallas relevantes
|
|
5. **Consejos** - Mejores prácticas
|
|
6. **Troubleshooting** - Problemas comunes
|
|
|
|
### 3. PLAN DE DOCUMENTACIÓN
|
|
|
|
#### Semana 1: Funcionalidades Básicas
|
|
- [ ] Acceso al sistema
|
|
- [ ] Navegación general
|
|
- [ ] Panel principal
|
|
|
|
#### Semana 2: Gestión de Contenido
|
|
- [ ] Expedientes
|
|
- [ ] Documentos
|
|
- [ ] Búsquedas y filtros
|
|
|
|
#### Semana 3: Funcionalidades Avanzadas
|
|
- [ ] Procesos
|
|
- [ ] Administración
|
|
- [ ] Reportes
|
|
|
|
#### Semana 4: Integración y Finalización
|
|
- [ ] VUCEM
|
|
- [ ] Notificaciones
|
|
- [ ] Revisión y ajustes
|
|
|
|
### 4. CONSIDERACIONES TÉCNICAS
|
|
|
|
#### Responsive Design:
|
|
- Documentar vista desktop
|
|
- Documentar vista móvil/tablet
|
|
- Mostrar cómo cambia la interfaz
|
|
|
|
#### Roles de Usuario:
|
|
- Importador
|
|
- Administrador
|
|
- Grupos específicos (3,5)
|
|
|
|
#### Estados del Sistema:
|
|
- Con datos
|
|
- Sin datos
|
|
- Estados de carga
|
|
- Estados de error
|
|
|
|
### 5. FORMATO DE DOCUMENTACIÓN
|
|
|
|
#### Para cada pantalla incluir:
|
|
```markdown
|
|
## [Nombre de la Funcionalidad]
|
|
|
|
### Descripción
|
|
Breve explicación de qué hace esta funcionalidad.
|
|
|
|
### Acceso
|
|
Cómo llegar a esta pantalla.
|
|
|
|
### Elementos de la Interfaz
|
|
1. **Header/Encabezado**: [descripción]
|
|
2. **Barra lateral**: [descripción]
|
|
3. **Área principal**: [descripción]
|
|
4. **Controles**: [descripción]
|
|
|
|
### Procedimientos
|
|
#### Para [acción específica]:
|
|
1. [Paso 1 con screenshot]
|
|
2. [Paso 2 con screenshot]
|
|
3. [Resultado esperado]
|
|
|
|
### Consejos y Buenas Prácticas
|
|
- [Consejo 1]
|
|
- [Consejo 2]
|
|
|
|
### Problemas Comunes
|
|
- **Problema**: [descripción]
|
|
**Solución**: [pasos para resolver]
|
|
```
|
|
|
|
### 6. CONTROL DE CALIDAD
|
|
|
|
#### Checklist por sección:
|
|
- [ ] Screenshots actualizados
|
|
- [ ] Pasos verificados
|
|
- [ ] Texto claro y conciso
|
|
- [ ] Formato consistente
|
|
- [ ] Links funcionando
|
|
- [ ] Información de roles correcta
|
|
|
|
### 7. HERRAMIENTAS DE COLABORACIÓN
|
|
|
|
#### Para equipos:
|
|
- **Slack/Teams** - Comunicación
|
|
- **Trello/Jira** - Seguimiento de tareas
|
|
- **Google Drive/SharePoint** - Almacenamiento colaborativo
|
|
- **GitHub** - Versionado si usas Markdown
|
|
|
|
### 8. MANTENIMIENTO
|
|
|
|
#### Plan de actualización:
|
|
- Revisar cada release
|
|
- Actualizar screenshots con cambios de UI
|
|
- Verificar procedimientos
|
|
- Actualizar enlaces y referencias
|
|
|
|
## Próximos Pasos
|
|
|
|
1. **Configurar entorno de documentación**
|
|
2. **Definir estilo y formato**
|
|
3. **Crear plantillas**
|
|
4. **Comenzar con funcionalidades básicas**
|
|
5. **Establecer proceso de revisión**
|