Plantilla de guía operativa¶
Use esta plantilla para ampliar el InfoCenter sin rebajar su nivel de evidencia. El orden importa: responde primero para qué sirve, y solo después dónde se pulsa.
Ficha de verificación¶
Va al principio de la guía, no al final. Sin ella, el lector no puede saber si lo que lee sigue vigente.
| Dato | Qué registrar |
|---|---|
| Versión de la guía | V1.1 o la que corresponda |
| Fecha de verificación | Fecha real de la comprobación |
| Código observado | SHA completo de la rama funcional |
| Entorno | Proyecto, tipo de build y su estado |
| Rol usado | El rol real con el que se comprobó |
| Datos | Sintéticos, de demostración o autorizados |
| Estado externo | No aplica, pendiente o evidencia concreta |
| Alcance de comprobación | Código contrastado / pantalla observada / acción ejecutada; nunca intercambiables |
| Pasos pendientes | Paso exacto, motivo, responsable y condición para retomarlo |
Estructura¶
La navegación principal nace de una intención («Quiero obtener mi informe de costo»), no del nombre del modelo. El catálogo de menús conserva la cobertura exhaustiva como referencia.
Plantilla de cada paso¶
- Haz esto: verbo y nombre literal del botón o pestaña; entrada exacta.
- Llena esto: valor de ejemplo, formato y si el campo es obligatorio, condicional o calculado.
- Mira aquí: captura real próxima a la acción, ampliable y con rol, compañía, fecha y SHA. No insertar una imagen del sitio para sustituir una pantalla de Odoo.
- Debe aparecer: registro, estado, detalle o archivo verificable; no darlo por obtenido solo porque el botón existe en código.
- Si no aparece: comprobación de compañía/período, causa observada o hipótesis identificada, responsable y recuperación.
Al final: qué cotejar del resultado, qué conservar y cuál es el siguiente objetivo. Para informes, abrir la descarga y revisar contenido es un paso obligatorio; descargar no es revisar.
Orden de la guía¶
- Qué vas a lograr — el resultado, en una frase.
- Para qué sirve — la intención de negocio.
- Qué no hace — los límites, antes de que alguien los descubra tarde.
-
Antes de empezar — rol, compañía, datos, configuración y dependencias.
Rol Datos Configuración Dependencia externa -
Ruta exacta — aplicación > contenedor > opción, y si se ejecuta con botón, con asistente o si no tiene entrada en la interfaz.
- Datos a ingresar — campo, obligatoriedad, formato, ejemplo sintético y efecto.
- Pasos — una intención por paso, con la imagen junto al texto que la explica.
- Resultado esperado — estado, valores o archivo observable.
- Cómo comprobarlo independientemente — sin repetir el mismo camino que lo produjo.
- Evidencia que debe conservarse.
-
Errores y recuperación.
Lo que ves Causa probable Qué revisar Cómo recuperarte Escalar a -
Cobertura funcional y límites.
- Guías relacionadas — de dónde viene y cuál es el siguiente paso.
Reglas que no se negocian¶
- No invente rutas, campos, estados ni resultados. Si no lo verificó, no lo escriba.
- «Intente de nuevo» no es una recuperación. Diga qué permiso, dato, gate, período o soporte revisar.
- Distinga control local, evidencia local, prueba UAT y aceptación externa. Nunca afirme que un tercero aceptó algo sin evidencia atribuible.
- Si una operación no tiene botón, dígalo en la guía; no deje que el lector lo descubra buscando.
- Ninguna captura con secretos, credenciales ni datos personales reales.
- Separar preparación RR. HH./administrador, operación mensual y revisión; no elevar permisos para evitar cambiar de sesión.
- No documentar un PR abierto como disponible. Tras el merge, revalidar SHA y build antes de completar el mismo ejemplo por interfaz.
- Separar QA de portada, QA de guía completa y ejecución funcional. Un recibo o comprobante solo se acredita tras generarlo y revisarlo realmente.