Iniciación a SherpaBots

El segundo punto que vamos a ver en este tema hace referencia a la documentación. A estas alturas, ya te habrás fijado que casi todo tiene un botón azul que pone “Documentación”.

Bien, esta es una parte fundamental de SherpaBots, tanto para la ayuda al usuario como en el desarrollo. La última parte de cualquier desarrollo, por pequeño que sea, es documentar todo el proceso. Así vamos a seguir el orden que hemos seguido en la formación para ver cómo documentar todos los puntos básicos. Siempre tenemos que tener en cuenta que hemos de ser lo más específicos posibles ya que tanto el usuario como el desarrollador tiene que tener muy claro cómo funcionan los procesos aunque no lo hayan desarrollado ellos.

Antes de nada, existe un concepto que usamos bastante en SherpaBots que el de “singularidad”. ¿Qué es una singularidad? 

• La singularidad es el filtro singular bajo el que se descargan los datos. Por ejemplo en un SquareExcel o una Template, la singularidad será el filtro que pongamos que suele ser Centro/Site/Ud. de Gestión y fecha. 
• Items, una galleta tipo ITEM es una galleta que contiene algún concepto que merece la pena explicar a parte ya que es compartido por varias galletas. Por ejemplo, cuando en RRHH humanos estamos hablando de los tipos de hora, no podemos explicar qué es cada tipo de hora en todos las galletas asociadas a este concepto. Entonces, lo que podemos hacer es crear ese ITEM y cada vez que aparezca ese concepto en las galletas lo enlazamos al ITEM. Lo veremos en un ejemplo práctico más adelante (2.2)

Veamos ahora cómo documentar los principales tipos:

Upload, SquareExcel, App, Bloque con Moduform, Plantilla o Template

2.1 Documentar un Upload.

Bien, lo primero que haremos será ver un par de ejemplos de las documentaciones de los Uploads y ver qué puntos son importantes para rellenar en este tipo de documentaciones.

Por ejemplo vamos a ver la carga de facturas de CEPSA PORTUGAL.

Aquí vemos un ejemplo de documentación de un Upload. Al darle a Editar, vemos cómo se ha rellenado esta “galleta” que es como llamamos a las piezas de documentación:

Primero vemos un desplegable que nos indica el Tipo. A continuación, vemos el nombre del Upload y una descripción corta que será la frase que veamos debajo del bloque y como primera frase de la galleta.

A continuación, veremos la Descripción Humanoide, que es la explicación más extensa donde se explican cosas básicas de cualquier Upload y cosas específicas del mismo:

Bien, cualquier Upload tiene que incluir los siguientes elementos:

• Descripción breve del contenido de la carga
• Singularidad, si la hubiera
• Descripción más concreta del proceso que debe incluir:
  • Cargas relacionadas, mapeos u otros Uploads necesarios.
  • Formatos específicos que deben tener celdas sobre todo el relación a las fechas
  • Explicación de las validaciones (Stops) más importantes
  • Explicación de las alarmas, si las hubiera.
  • Explicación de los cálculos que se realizan, en caso de que existan.
  • Donde “acaba” la información (SquareExcel, Web, Interface Flyout, mail, etc.)

 

2.2 Documentar un SquareExcel

Para documentar un SquareExcel tenemos que tener en cuenta 4 factores:

• Singularidad
• Breve descripción de cada hoja
• Items asociados, esto es crear los items que sean necesarios para la galleta.

 

Como siempre, lo mejor un ejemplo:

Veamos la documentación del SquareExcel Resumen Horas. 

Aquí vemos una primera frase genérica y la descripción del la singularidad.

Luego aparece, un detalle de las hojas que estamos usando. En este informe los tipos de hora se despliegan en todas las opciones posibles, y vemos marcados en azul aquellos conceptos que están asociados a los ITEMS.

Al hacer click en alguno de ellos vamos directamente a su propia galleta:

Otro ejemplo:

Etc., etc.

De un ITEM a otro podríamos recorrernos todo SherpaBots, pero esto nos sirve para tener galletas lo más sintéticas posibles y, de hecho, reaprovechar la información para no tenerla duplicada en cada galleta que aparece.

Para crear un ITEM, tenemos que poner la palabra “ITEM” en mayúsculas seguida del título del ITEM y un espacio al después:

Vamos a hacer uno, por ejemplo. Hemos puesto “ITEM_prueba_formacion .” para ver qué pasa al guardarlo. 

al guardar veremos el link asociado en rojo:

Al hacer click sobre él llegamos a una galleta vacía, por lo tanto tenemos que crear esa galleta (en la parte derecha de la pantalla de inicio de documentación).

Aquí elegimos el tipo “ITEM”, el título, “prueba formacion” y luego pondremos una descripción breve:

Guardamos cambios y veremos cómo el link donde hemos puesto el ITEM ya se ha convertido en azul y nos enlaza a nuestra nueva galleta.

2.3 Documentar una APP.

Para documentar una APP tendremos que buscar la APP en la app de documentación:

En este caso el tipo de galleta es “WEB” y vamos a usar la app de ejemplo “Penguins of the world” hacemos click en filtrar:

***Aquí hay que definir cómo se documenta una App*** si por TEMPLATE o WEB o crear uno nuevo APP

 

Una vez documentada la app, podemos tener bloques independientes con sus moduforms que ejecutan procesos o asociados a una template, además de los que ya hemos visto (Upload, SquareExcel).

 

2.4 Documentar un Bloque con Moduform

Para documentar un bloque tenemos que explicar cómo funciona y cómo rellenarlo. Por ejemplo, el bloque CREAR ÁREA que es muy sencillo se explicaría así:

En el caso de un moduform más complicado tendríamos una explicación más amplia:

En este caso tenemos que tener en cuenta la complejidad y explicar bien claro cómo se usa.

 

2.5 Documentar una Plantilla o Template

Este caso es muy similar al del SquareExcel pero el tipo de galleta será “Template” y será la misma documentación para todos los bloques de la App con Template. Así, además de explicar:

• Singularidad
• Breve descripción de los datos descargados

También tendríamos que poner:

• Cómo rellenar la plantilla
• Cada cuanto se sube
• Características concretas

 

Veamos cómo está documentada la plantilla de Accidentabilidad:

Como vemos, una template común para una App se documenta también lo que hace la APP (que es básicamente descargar, actualizar y cargar la plantilla de cada bloque). Luego, se indica qué filtros son necesarios (singularidad) y la hoja u hojas para rellenar. Indicamos por un lado los datos descargados y por otro los que hay que cargar y cómo.