Formato de wikis de Cronus ERP
IMPORTANTE
- Los wikis deben de pasar por QA antes de ser marcados como completados.
- Se debe de apoyar en la inteligencia artificial para la revision de ortografia y gramatica.
Formato General
- Cada seccion dividida por linea horizontal.
- El formato de titulos es de:
- Titulos de secci贸n:聽Arial 16, Negrita e italica.
- Titulos dentro de secciones:聽Arial 12, Bold.
- El formato de escritura es de: Arial 12, Justificado e Im谩genes centradas.
- A la hora de colocar im谩genes no se dejara espacio con el campo de arriba pero se dejaran 2 espacios con el de abajo.
Nombre de pantalla y link de Wiki
- El link de cada wiki se crea en base a su ruta:
- Sistema -- CRONUS
- Modulo --聽CXC
- Submodulo --聽Otros
- Nombre de pantalla --聽Clasificacion-ABC
- EJ:聽CRONUS-CXC-Otros-Clasificacion-ABC
- El nombre de cada pantalla es m谩s sencillo:
- Nombre de pantalla -- Clasificaci贸n聽ABC
- Sistema al que corresponde -- Cronus ERP
- EJ:聽Clasificaci贸n ABC de Cronus ERP
- Luego del titulo debe de ir una linea horizontal, para agregarla debe de ir a insert en la edicion de wikis de edit me y聽 usar la horizontal line.
Secci贸n #1
- Como titulo de esta secci贸n se debe de colocar聽Acceso y Requisitos Previos.
- Si esta pantalla requiere alg煤n tipo de configuraci贸n previa el siguiente titulo debe de ser聽Wikis de pasos previos :
- El siguiente titulo que debe de llevar esta seccion es el de聽Permisos de la seguridad para el proceso :聽
- Se debe de enumerar cada derecho ocupado, estos deben de ir entre "" y deben de tener una rapida explicaci贸n de su funci贸n
- El ultimo titulo de esta secci贸n debe de ser聽La pantalla de (nombre de pantalla) se encuentra en :
- Este debe de venir acompa帽ado de un punto con su ruta y una foto de la misma
- Ejemplo general de聽secci贸n :
Secci贸n #2
- Como titulo de esta secci贸n se debe de colocar Uso de la Pantalla: xyz.
- En esta secci贸n se debe redactar una explicaci贸n completa, clara y rigurosa de todas y cada una de las opciones disponibles en la pantalla.
- El objetivo es que el lector pueda comprender con precisi贸n la funci贸n de cada bot贸n, men煤 u opci贸n disponible, sin necesidad de conocimientos previos.
- Se deben de agregar las explicaciones de cada boton de la pantalla, como ejemplo:
- Agregar
- Utilitarios
- Refrescar
- En los casos en que una opci贸n lleve a otra pantalla o m贸dulo, tambi茅n se debe incluir una descripci贸n detallada de todas las funciones y opciones disponibles en esa nueva interfaz, siguiendo el mismo nivel de detalle y claridad.
- Este apartado debe servir como una gu铆a de referencia para el uso correcto de la pantalla, por lo tanto, es importante evitar ambig眉edades y cubrir todos los posibles escenarios de uso.
- En caso de que no sea posible explicar las funciones de la pantalla, casos opuestos a la de facturaci贸n, se debe buscar describir su prop贸sito general. Por ejemplo:
- La pantalla de pron贸stico simple cuenta con un bot贸n "Agregar" y varias opciones, pero lo importante de la misma es el detalle de los c谩lculos. Se debe explicar este detalle, qu茅 lo compone, cu谩les son sus columnas, entre otros aspectos.
Secci贸n #3
