Objeto
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.
Debemos tener en cuenta que, en la mayoría de los casos, dicho 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.
Recuerda que el usuario que registra una solicitud puede hacer seguimiento de las actuaciones realizadas sobre la misma tanto en la app móvil ayudaDIGITAL como en el área personal de ayudaDIGITAL. 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)
Esta guía aplicaría para aquellas actuaciones visibles por el usuario. En aquellas otras en las que se marca en Nueva Web Técnica la opción “No 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:
| Nº | Buena práctica |
|---|---|
| 1 | Haz buen uso de la gramática, respetando las reglas ortográficas y redactando de una manera clara y sencilla. |
| 2 | Escribe en un lenguaje formal y en segunda persona del singular, para así darle al usuario sensación de cercanía (hablar de tú). |
| 3 | Recuerda que somos un solo equipo, por lo que habla en primera persona del plural. “Hemos procedido a…” |
| 4 | No des órdenes, no escribas en mayúsculas, y no hagas uso de exclamaciones, evitando por tanto que el usuario se sienta ofendido. |
| 5 | No uses diminutivos. |
| 6 | No uses expresiones negativas. |
| 7 | 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. |
| 8 | Si tienes la necesidad de nombrar a otro profesional, compañero del servicio o usuario, refierete 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..." |
| 9 | 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…. |
| 10 | 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 |
| 11 | 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. |
| 12 | 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. |
| 13 | No incluir datos sensibles (datos de usuario, contraseñas etc.). |
| 14 | Si fuese necesario, utilizar una lista numerada o viñeta, utiliza los siguientes criterios:
Paso 1: xxx Paso 2: xxx
Opción 1: xxxx Opción 2: xxxx |
| 15 | Para realizar alguna recomendación, advertencia, utiliza: " Ten en cuenta que" o "Recuerda que..." |
Vista general
Herramientas de contenido
- Impreso por Atlassian Confluence 8.7.2