...
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 evitando terminología que presten 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 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:
Paso 1. Texto Paso 2. Texto Paso 3. Texto
|
21 | Para realizar alguna recomendación, advertencia, utiliza: ' Ten en cuenta que' o 'Recuerda que..' |
22 | 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:
|
...