Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

N.º

Descripción

1

Respetar siempre las reglas de ortografía.

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
Seguirán los siguientes criterios:

  • En los KIs de gestión de acceso (error de contraseña) empezaremos la oración con el texto: No puedo entrar + nombre aplicación, mensaje...

    Ej: No puedo entrar en AGESCON, mensaje: "Error de acceso. Debe indicar un usuario y contraseña válido".
  • Los KIs tipo V1M (vídeos 1 minutos), el título se compone con el texto: Vídeo tutorial de+ Nombre de aplicación- funcionalidad (si procede)

    Ej: Video tutorial de ClicSalud+
    Video tutorial de RECDOM-Solicitud retirada material

4

Escribir en un lenguaje formal y en segunda persona del singular, para así darle al usuario sensación de cercanía.

5

El KI tiene que estar actualizado 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

El contenido de un KI (texto, captura, vídeo, etc.) no puede contener 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 dobles ("") se limita a la cita de un mensaje.

11

Se utilizará la "negrita" para destacar alguna palabra, nunca para una frase completa.

12

El uso de cursivas se limitará a tecnicismos.

13

Limitar el uso de los paréntesis.

14

No usar exclamaciones

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.
Utiliza para remarcar los mensajes de error /advertencia el color rojo y para indicaciones o resaltar opciones de menú el color verde. Ver ejemplo 2.2

17

Para KI tipo FAQs, FSI y FER el formato es consulta/pregunta y respuesta. No utilizando preguntas abiertas que requieran 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 clasificaran por módulos y funcionalidades

20

Cuando sea necesario usar una lista numerada o viñeta se utilizarán los siguientes criterios:

  • Si se va a informar de cómo realizar una configuración, empezaremos la oración: "Realiza los siguientes `pasos´" seguida del número correspondiente.

    Ej.: Para configurar la impresora, realiza los siguientes pasos: Paso 1. Texto. Paso 2. Texto. Paso 3. Texto.
  • Si es necesario realizar una serie de comprobaciones, empezaremos la oración: "Realiza las siguientes `comprobaciones´".

    Ej.: Para comprobar que un usuario se encuentre dado de alta como profesional accede a Maco y realiza las siguientes comprobaciones:
    • Entra en centralización de operadores.
    • Gestión de módulos.


  • Si para una misma casuística se pueden dar distintas circunstancias que requieren diferentes soluciones, empezaremos la oración: "Se pueden dar los siguientes `casos´".


    Ej.: ¿Cómo anuló el alta de un episodio?
    Se pueden dar los siguientes casos:
    Caso 1. No han pasado más de 24h desde el alta del episodio y el motivo de derivación es "Domicilio".
    Texto solución.
    Caso 2. No han pasado más de 24h desde el alta del episodio y el motivo de derivación es "ingreso en planta".
    Texto solución.
    Caso 3. No han pasado más de 24h desde el alta del episodio y el motivo de derivación es "Exitus".
    Texto solución.
    Caso…

  • 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.

21

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

...

Ancla
_Ejemplos
_Ejemplos
Ancla
_Toc32060737
_Toc32060737
Ancla
_Toc45281643
_Toc45281643
Ejemplos Ejemplos 

Ejemplo Títulos KI´s

¿Cómo cambió la contraseña desde AGESCON sin utilizar las preguntas de seguridad?

¿Cómo puedo traspasar la agenda de un profesional a otro?

¿Cómo habilitó el RDP en un Pc para poder conectarme?

GRA-Virgen de las Nieves- Active directory-No puede añadirse un equipo al grupo porque ya está en él.

1.1 FAQs.SIGLO. ¿Cómo se reduce el importe de un contrato?

Problema de Desconexión Automática de Gerhonte en puesto de Usuario

...