...
Ancla | ||||
---|---|---|---|---|
|
...
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 | Los atributos tipo texto tienen que ser claros y concisos La solución debe responder de manera clara y sencilla al título, a nada mas. El texto tiene que ser claro y conciso evitando terminología que presten preste a confusión. | ||
3 | Los títulos tienen que ser cortos y basados en una acción, haciendo referencia al ámbito al que aplica (Ej. iniciar sesión en el terminar, tipo de puesto de trabajo…). No incluir en el título caracteres extraños (*,/), ni el tipo de KI, ni ninguna numeración. Ver ejemplo 2.1
| ||
4 | Escribe en un lenguaje formal y en segunda persona del singular, para así darle al usuario sensación de cercanía (hablar de tú) | ||
5 | La información debe estar actualizada y el contenido debe ser útil para el profesional | ||
6 | Para referenciar 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 | ||
7 | Limitarse únicamente a detallar la funcionalidad definida en la aplicación | ||
8 | No incluir datos sensibles (datos de usuario, contraseñas etc.) | ||
9 | Formato del texto; tipo de letra: Arial, tamaño 10 y color de letra negro | ||
10 | El uso de comillas simples (' ') se limita a la cita de un mensaje | ||
11 | Se utilizará la 'negrita' para destacar alguna palabra, nunca para una frase completa | ||
12 | Para soluciones de 'usuario final' evita tecnicismos. Si aplica usarlos para soluciones de 'Usuario TIC' utiliza cursiva | ||
13 | Limitar el uso de los paréntesis | ||
14 | No des órdenes, no escribas en mayúsculas, y no hagas uso de exclamaciones, evitando por tanto que el usuario se sienta ofendido. | ||
15 | Se utilizará coma para separar y hacer pequeñas pausas en un texto, párrafo u oración, salvo los que vengan precedidos por alguna de las conjunciones y, e, o, u o ni. Hay tendencias que admiten su uso previo a una conjunción | ||
16 | Se permite el uso de imágenes como complemento al texto o aclaración, no pudiendo superar el tamaño de 4 MB. Los formatos permitidos son: gif, jpg o png | ||
17 | Para KI tipo FAQs, FSI y FER el formato es consulta/pregunta y respuesta. No utilizando preguntas abiertas que requieren respuestas largas | ||
18 | Los iconos que se utilicen tienen que ser los ya utilizados en las aplicaciones facilitando así el reconocimiento rápido por parte del usuario y deben poder ser vistos por parte del usuario desde diversos dispositivos (PC, terminales, smartphones) | ||
19 | Las preguntas se clasificará por módulos y funcionalidades | 20 | Cuando sea necesario usar una lista numerada o viñeta se utilizarán los siguientes criterios:
1.Texto . Paso2. Texto . Paso3. Texto .
situaciones: CasoOpción 1. No han pasado más de 24h desde el alta del episodio y el motivo de derivación es 'Domicilio'. Opción 2. No han pasado más de 24h desde el alta del episodio y el motivo de derivación es 'ingreso en planta'. Opción 3. No han pasado más de 24h desde el alta del episodio y el motivo de derivación es 'Exitus'. Si existen diferentes formas de realizar una misma acción, empezaremos la oración: 'Tienes las siguientes ´opciones´: Ej.: ¿Cómo cambio el proxy? Tienes las siguientes opciones: Opción 1. Opción 2. Opción 3. |
20 | 21 | Para realizar alguna recomendación, advertencia, utiliza: ' Ten en cuenta que' o 'Recuerda que..' | |
21 | Para KIs tipo vídeos. Debes dejar el vídeo en el espacio de confluence de la aplicación. Crea el KI y haz referencia a este enlace. Ten en cuenta:
| ||
22 | Algunos iconos que puedes utilizar: →, ✓ |
Ejemplos: Títulos de soluciones y contenido del KI
Ancla | ||||
---|---|---|---|---|
|
Ancla | ||||
---|---|---|---|---|
|
Ancla | ||||
---|---|---|---|---|
|
...
Contenido del KI | ||
---|---|---|
| Realiza los siguientes pasos:
| |
| Comprobar el navegador que está utilizando para trabajar en la aplicación, debe utilizar IE 8. Eliminar caché, cierra la aplicación y vuelve acceder. Si acede desde un acceso directo en el escritorio o navegador, accede directamente indicando la URL en el navegador. |
...
Campo | Contenido |
---|---|
TIPO Solución: | Nombre descriptivo que identifique el destino y uso del KI |
TÍTULO | Nombre descriptivo que identifique el KI para los usuarios. |
PÚBLICO OBJETIVO | Tipo de audiencia de destino de KI, los destinados a usuarios finales deben estar claramente identificados. (funcional/técnico) |
EVIDENCIAS | Listado de evidencias con las que el KI tiene una relación directa. Se tendrán que indicar en los KI tipo FAQ, FSU y ECR |
INFORMACIÓN PARA EL REGISTRO | Información para incluir en los campos de la solicitud cuando se esté registrando si no existe una plantilla preestablecida para escalarse. (Tipología, CI, ID de usuario, dirección IP). |
INFORMACIÓN PARA EL ESCALADO | Grupo de resolución a asignar el ticket tras su registro. Esta información será extraída de la matriz de escalado. |
BREVE RESUMEN DE LA SOLUCIÓN | Resumen de la resolución de la solicitud. Es el texto que aparecerá automáticamente en la solicitud cuando esta sea resuelta, quedará asociada al código de KI, llegando al usuario final a través de una notificación, "motivo de cierre". El cual podrá ser editado por el CSU y resolutor antes del cierre. |
DESCRIPCIÓN COMPLETA DE LA SOLUCIÓN | Información detalle del KI, que, para el caso de manuales, guías y vídeos, contendrán un link al repositorio de contenidos. |
LINK | Link ConfluenceSSHH, contenedor de la información de detalles, aplicable para TST,TUM, TUP (), EUG, EUM, V1M, ECR, EUS, |
CIs RELACIONADOS | Otros CIs con los que tiene relación este KI. |
KIs RELACIONADOS | Otros KIs con los que tiene relación este KI. |
...