Guía de buenas prácticas para documentar solicitudes



Objetivo

El objeto de este documento es plasmar una guía de buenas prácticas a la hora de documentar cada una de las actuaciones de una solicitud de manera que, la redacción de dicha actuación sea entendible y apropiada para la persona que va a leer la misma, el usuario afectado. En la mayoría de los casos,  el usuario afectado no es personal técnico y sólo está esperando que le solucionemos su necesidad informática para así, poder continuar ejerciendo su trabajo.

Hay que tener en cuenta que el usuario que registra una solicitud puede hacer seguimiento de las actuaciones realizadas sobre la misma (tanto desde la app móvil ayudaDIGITAL como el área personal de ayudaDIGITAL). Y que además, recibe una notificación informando del contenido de dicha actuación (salvo en los casos en los que no aplique, cuando se marca la opción "No visible por el usuario" en NWT).


Aplicación de esta guía:

Esta guía aplica a aquellas actuaciones que sean visibles por el usuario. En aquellas otras actuaciones, en las que NO se marque en Web Técnica la opción “visible por el usuario”, se podrá tener más libertad en cuanto al uso de tecnicismos o referencias a acciones concretas, quizás menos entendibles por el usuario afectado, ya que se presupone que son actuaciones dirigidas a compañeros.

Buenas prácticas para los comentarios visibles de las actuaciones


Buena práctica

check mark button Haz buen uso de la gramática, respetando las reglas ortográficas y redactando de una manera clara y sencilla.

check mark button Escribe en un lenguaje formal y en segunda persona del singular, para así darle al usuario sensación de cercanía (hablar de tú).

check mark button Recuerda que somos un solo equipo, por lo que habla en primera persona del plural. “Hemos procedido a…”

check mark button Si tienes la necesidad de nombrar a otro profesional, compañero del servicio o usuario, refiérete a él con cortesía, con su cargo o su nombre y apellidos. Ej. "Se comprueba con el responsable de enfermería", "Se informa al profesional sobre...." , "Se comprueba con el compañero nombre apellidos que...".

check mark button El usuario recibe la descripción de la actuación en una notificación enviada por correo electrónico. Esta notificación está aplantillada con su correspondiente saludo y pie de firma, por lo que no es necesario que en tu actuación incluyas mensajes como " ¡Hola!, gracias, un saludo, estimado usuario…". 

check mark button Si fuese necesario hacer referencia a información complementaria se podrá incluir enlaces a páginas corporativas o repositorios, asegurando el acceso a los mismos desde plataformas Citrix y desde fuera de red corporativa.

check mark button Si fuese necesario, utiliza los siguientes criterios para listas numeradas o viñetas:

Realiza los siguientes pasos:

  1. xxx
  2. xxx

Realiza las siguientes comprobaciones:

  • xxx
  • xxx

Tienes las siguientes opciones:

  1. xxx
  2. xxx

check mark button Para realizar alguna recomendación o advertencia, utiliza: " Ten en cuenta que" o "Recuerda que...".


Mala práctica

(error) No des órdenes, no escribas en mayúsculas, y no hagas uso de exclamaciones, evitando por tanto que el usuario se sienta ofendido.

(error) No uses diminutivos.

(error) No uses expresiones negativas.

(error) No te refieras a compañeros de otros equipos. Ej. “Dani esto es para ti”; “Ana, a ver si puedes tú solucionarlo”, “Se habla con Antonio y dice que...”. Ten en cuenta que esta información no es necesaria para el usuario.

(error) Evita tecnicismos no entendibles por el usuario, abreviaturas y referencias a terminología propia de la gestión de solicitudes como mejoras, JIRA, problemas, PL, RFP, etc.

(error) Si la incidencia que estás atendiendo se asocia a un problema no la cierres indicando "se está gestionando en el problema xxxxxxx" sin aportar una solución, al menos temporal.

(error) No incluir datos sensibles (datos de usuario, contraseñas etc.).

(error) No resuelvas una solicitud con frases condicionales, ni pidiendo al usuario verificar información que debes comprobar, como resolutor (Ej. "Suele ocurrir cuando...comprueba si..."). Antes de resolver, valida todos los datos necesarios y ofrece un diagnóstico claro y definitivo.