Como elaborar una FAQ:
- Veronica Restrepo Garcia (Deactivated)
- Isabel Cristina Gaviria
Descripción
El término preguntas frecuentes (traducción al español de la expresión inglesa Frequently Asked Questions, cuyo acrónimo es FAQ) se refiere a una lista de preguntas y respuestas que surgen frecuentemente dentro de un determinado contexto y para un tema en particular.
En S4DS existen 2 tipo de FAQS:
1) FAQs de cara a los clientes: ubicadas en la siguiente ruta: FAQs estas FAQs pretender mostrarle a los clientes soluciones frente a sus dudas ante temas reincidentes o comunes, por ejemplo:
Como trabajar con productos sustitutos? para evitar dar una y otra vez el paso a paso se creo el siguiente documento: ¿Cómo activar los productos sustitutos?
Tener en cuenta que una FAQ de clientes nunca debe llevar o relacionar SQLs o temas técnicos.
Nunca debe contener pantallazos que muestren información de un cliente en específico, siempre deben ser de demo.
2) FAQs internas: ubicadas en la siguiente ruta: FAQs Internas estas FAQs pretender solucionar situaciones internas frente a escenarios especificos, por ejemplo: Interno: ¿Como puedo cambiar el Subject de una plantilla? esto es una tarea que se logra mediante la ejecucion de SQLs, actividad que no pueden realizar los clientes y por eso se crear restringidas y como apoyo a soporte que damos.
Estas FAQs deben relacionar toda la información técnica necesaria para atender un caso.
No importa que sean pantallazos de clientes especificos.
De acuerdo al modelo del cliente pueden haber FAQs especificas para un cliente en especial de acuerdo al tema, ejemplo: Tupperware: Como validar si se tienen pedidos con la novedad de los combos
Como se toma la información para las FAQs:
La información sale de cada caso que reportan los clientes y de los mismos equipos de trabajos, cuando un caso tiene información para documentar se marca con el label: Knowledge_Base
Luego aunque el caso se cierre o indistintamente el estado en el que este mientras tenga el label de indentificación se debe hacer la documentanción, una vez se haya realizado se debe cambiar el label y colocar S4dsDocumentation
Estructura de una FAQ:
Título: el título debe ser clave para que sea fácil de identificar mediante búsquedas por palabras claves, importante que el título inicie con el módulo ejemplo: Producto: como se carga la imagen de un producto?
Consulta: ¿Cómo se generan las facturas desde consulta centralizada?
Por tanto, debe quedar así:
Señalando el módulo es mas fácil su búsqueda:
2) Descripción: da un breve resumen de la situación que se presenta, ejemplo:
En ocasiones se puede presentar en el sistema que algunos consultores no se pueden editar ya que al guardar la información se genera el siguiente mensaje:
"Error actualizando cliente"
3) Causa: se debe explicar el origen de la situacion presentada, ejemplo:
Este mensaje se genera cuando en la identificación del cliente hay caracteres especiales (Puntos, comas, guiones) y esto genera el mensaje al guardar la información.
4) Pasos a seguir o solucion: indicar como atender el caso, que se debe revisar, como se soluciona, ejemplo:
Cuando ésto suceda, es necesario revisar que no exista un RAMDON configurado, ya que esto prevalece sobre la configuración del campo del sponsor.
La variable de entorno para revisar ésto es RANDOM_CUSTOMER_REQUIREMENTS. Cuando esta variable esté vacía y la variable de entorno del sponsor se encuentra en T, se mostrará este campo en el registro.
Como crear un documento en JIRA:
1) Clic en el simbolo +
2) Clic en Blank Page:
3) Clic en boton CREATE:
4) Se crea el espacio en blanco para comenzar a desarrollar el contenido, definir la ubicacion (FAQ o FAQ Interna)
5) Por ultimo clic el publicar