Estructura de cada explicación (§3.1)
Sección titulada «Estructura de cada explicación (§3.1)»Cada proceso documentado en los manuales debe contener, en el orden que resulte más natural:
- Objetivo del proceso.
- Usuario o rol responsable.
- Requisitos previos.
- Punto exacto del menú donde inicia.
- Instrucciones numeradas paso a paso.
- Capturas de las pantallas principales.
- Resultado esperado y estados posibles.
- Errores frecuentes y forma de resolverlos.
- Notificaciones generadas.
- Etapa siguiente del trámite.
- Enlace o referencia al video correspondiente.
Los capítulos nuevos usan el componente ProcDoc, que aplica esta estructura de forma consistente.
Capturas de pantalla (§3.2)
Sección titulada «Capturas de pantalla (§3.2)»- Mostrar desde dónde inicia la acción, incluyendo el menú, módulo o expediente.
- Resaltar botones, campos o estados importantes sin ocultar el contexto.
- Utilizar datos ficticios o anonimizados; nunca credenciales ni información personal real.
- Mantener el mismo tamaño, resolución, estilo de señalización y pie de imagen.
- Mostrar variantes cuando la pantalla cambie por estado, resultado o rol.
Convención de nombres: [manual]_[modulo]_[proceso]_[paso]_[descripcion].png
Ejemplo: externo_pago_tarjeta_03_confirmacion.png
Videos (§3.3)
Sección titulada «Videos (§3.3)»- Iniciar en el punto exacto del menú y finalizar mostrando el resultado esperado.
- Indicar el rol o tipo de usuario utilizado.
- Incluir narración o subtítulos; hacer visibles los clics, campos y botones.
- Recortar tiempos de espera; evitar información real o sensible.
- Incluir título, duración y proceso cubierto.
- Un recorrido general corto más videos específicos para procesos macro.
Los videos se publican en la sección Videos.
Arquitectura reutilizable (§3.4)
Sección titulada «Arquitectura reutilizable (§3.4)»Regla central: cada trámite debe llamar al proceso general correspondiente según su etapa. Solo se documentan dentro del trámite los requisitos, campos, reglas, excepciones o pantallas que sean particulares.
| Proceso reutilizable | Referencia en el trámite |
|---|---|
| Iniciar trámite | Proceso general — iniciar |
| Completar formulario | Formularios |
| Carga documental | Carga documental |
| Pago | Pagos |
| Observaciones | Observaciones |
| Notificaciones | Notificaciones |
| Resolución | Resoluciones |
Ejemplo de redacción en una ficha: «Para completar esta etapa, consulte Proceso general de un trámite, sección Carga documental.»
Principio de diseño documental (§1.2)
Sección titulada «Principio de diseño documental (§1.2)»Este enfoque evita repetir instrucciones, reduce el costo de mantenimiento y garantiza que una actualización del proceso común se realice en un solo lugar.