...
Ancla |
---|
| _Toc423363904 |
---|
| _Toc423363904 |
---|
|
El objeto de este documento es dar a conocer la manera de introducir la información en la base de datos de la Gestión del Conocimiento de la
STICDGSIC, para garantizar la accesibilidad y comprensión de los ítems por parte de todos los profesionales (TIC y no TIC). El Ítem de conocimiento (Knowledge Item, en adelante KIs) es la unidad mínima de información de la base de datos del conocimiento.
...
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 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 acceder + nombre aplicación, mensaje... : XXX
Ej.: No puedo entrar acceder en AGESCONÁrea personal ayudaDIGITAL, 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 | 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 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 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: - 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. pasos´ e indicando el nº
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 casossituaciones: Caso Opción 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 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'. Texto solución. Caso Opción 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. |
20 | 21 | Para realizar alguna recomendación, advertencia, utiliza: ' Ten en cuenta que' o 'Recuerda que..' | 22
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: - Debe ser formato mp4.
- Se recomienda indicar una introducción. El vídeo, no se iniciará automáticamente.
- Si tiene música, para facilitar la visualización en el entorno de trabajo se desactiva la música; siempre tiene a posibilidad de activarse.
- Frases tipo:
- Pulsa 'Play' para iniciar
- Puedes quitar
| /- o poner el audio seleccionando en el
Image Modified - Descubre en este vídeo cómo hacerlo
- Indica un breve resumen de como llegar a la funcionalidad o los pasos que se deben realizar
|
22 | Algunos iconos que puedes utilizar: →, ✓ |
Ejemplos: Títulos de soluciones y contenido del KI
...
Contenido del KI |
---|
|
No puedo entrar a AGESCON, mensaje: 'Error de acceso. Debe indicar un usuario y contraseña válido'
| Realiza los siguientes pasos: Paso 1. Accede a la URL: http://sgi.sas.junta-andalucia.es/agescon/ Paso 2. Introduce el usuario y deja el campo contraseña en blanco y pulsa en el enlace '¿Olvidó o bloqueó su contraseña?'
- Elige uno de los métodos de recuperación que hayas cumplimentado previamente para recuperar la contraseña
- Introduce el dato requerido en función del método de recuperación que hayas seleccionado y pulsa sobre 'Aceptar' o 'Validar' según proceda
- Introduce nueva contraseña y repítela. Pulsa en el botón 'Cambiar contraseña'
|
| Error al imprimir las cartas de cita de los pacientes de la especialidad de medicina interna.
| 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. Si accede desde citrix, cerrar la aplicación y probar a conectarse en otro servidor |
...