Cómo navegar por la documentación de Bitákora

Akádemy Docs es la documentación en línea que está al servicio de los usuarios de la aplicación de nómina Bitákora.

Queremos que nuestros usuarios conozcan la hoja de ruta para navegar por Akádemy Docs y le saquen el máximo provecho a los procesos que Bitákora tiene para liquidar y reportar la información de nómina.

En la siguiente imagen se observa el Administrador de categorías, el cual hace posible la navegación por la documentación que apoyará el uso de Bitákora.

Pero antes de entrar a explicar lo que se encuentra en cada una de las categorías de la documentación, se explicará como navegar en el portal de documentación de Akádemy Docs.

El sitio de documentación de Akádemy Docs se compone de la siguiente estructura:

1. Home o página principal de la documentación. Será la bienvenida a Akádemy Docs que permite buscar y navegar dentro de las categorías de Akádemy Docs.
2. Administrador de categorías. Para recorrer las diferentes categorías y subcategorías de la documentación.

A continuación se detallará cada una de las partes de la estructura del portal de la documentación.

Home o página principal de la documentación

Para el ingreso a la página de inicio de la documentación de Akádemy Docs, ingresar por la URL https://sincosoft.document360.io/bitakora/en.

Akádemy Docs está construida sobre la herramienta de documentación Document360, que brinda un sitio web donde los usuarios de Bitákora pueden acceder a la base de conocimientos para leer los artículos y encontrar respuestas que le ayudarán en la operación de nuestro software Bitákora.

El Home de Akádemy Docs contiene las siguientes opciones (ver imagen anterior donde están numeradas cada una de las opciones):

1. Barra de búsqueda del portal de documentación
2. Accesos directos a tres categorías principales de Akádemy Docs. Al dar clic se ingresará al Administrador de categorías y se mostrará el primer artículo de la categoría seleccionada.
3. Seleccionar por categoría. Se ingresará al Administrador de categorías y se mostrará el primer artículo de la categoría seleccionada.
4. Administrador de categorías. No es parte del Home, es el panel de opciones al que se pasa cuando se ingresa a una categoría o al seleccionar un artículo en la búsqueda.

A continuación solo se explicará del Home la barra de búsqueda, porque las demás opciones se contemplarán cuando se trate el Administrador de categorías en la parte final de esta sección.

Barra de búsqueda del portal de documentación

Akádemy Docs incluye un rápido e intuitivo buscador de artículos, que facilita la búsqueda de palabras o frases dentro de la documentación.

La búsqueda inteligente permite obtener ayuda instantánea dentro de los artículos que se relacionan con lo registrado en la casilla de búsqueda.

Se permite buscar por los siguientes atributos:

• Títulos de artículos y categorías
• Contenido de texto dentro de los artículos y categorías
• Etiquetas

Búsqueda por una frase no exacta

En la siguiente imagen se realiza una búsqueda por la frase "inicio rapido". Aunque la palabra rápido se escribió sin tilde, el buscador muestra las coincidencias con tilde y sin tilde.

Los primeros tres resultados de artículos están con la frase completa buscada (cuadro en color rojo de la imagen anterior), como no encontró más coincidencias exactas, se continúa la búsqueda ya no con la frase completa sino palabra por palabra, encontrando dos artículos que contienen solo la palabra "inicio".

Búsqueda por una frase exacta

Para buscar escriba la frase separando cada palabra con un guion.

En la siguiente imagen se observa la búsqueda de los artículos que contengan la frase exacta calendarios-comerciales.

Al dar clic sobre cualquier parte del resultado, la búsqueda lo dirige al artículo (ver imagen siguiente) y se podrá observar la ruta donde se encuentra el artículo en el Administrador de categorías de Akádemy Docs, que para este caso serían:

• Categoría: Eventos que afectan la liquidación
• Subcategoría: Vacaciones
• Artículo: Registrar vacaciones para un empleado

Estando dentro del artículo con el atajo del teclado se puede buscar con CTRL + F, que es propio de los navegadores como Chrome y sirve para buscar dentro de cualquier página o documento. Al pulsar este comando, surge un cuadro de búsqueda que permite introducir la palabra a buscar y moverse con las flechas de desplazamiento hacia el anterior o el siguiente resultado.

Búsqueda avanzada de la documentación

El enlace aparece en la parte inferior de la sección de resultados de la búsqueda.

Al dar clic en el enlace se mostrará el panel de búsqueda avanzada (imagen siguiente). En la barra superior se encuentran las opciones de filtro para restringir los resultados de la búsqueda y también mostrará la cantidad de resultados que produjo la búsqueda.

Las siguientes opciones de filtro están disponibles en la parte superior:

• Version / Language: Seleccionar Bitákora y English, que son las únicas opciones disponibles para la documentación de Bitákora.
• Category: Seleccionar si requiere buscar los artículos solo de una categoría o de varias.
• Contributors: Para filtrar los artículos de uno o varios de los colaboradores que escribieron la documentación.
• Tags: Para filtrar los resultados de la búsqueda con las etiquetas. Dejar por defecto todas, por el momento este filtro no tiene aplicación.
• Update on: Para mostrar los artículos que han sido actualizados en los últimos 7 días, 30 días, 3 meses, 1 año o en periodo de fechas que se puede especificar al seleccionar la opción.
• X: Solo se muestra en la parte superior derecha cuando se han seleccionado filtros y se usa para restablecer los filtros.

Administrador de categorías

Cuando en el Home de Akádemy Docs se selecciona una categoría o se utiliza la casilla de búsqueda, ese enlace se dirige al Administrador de categorías, que es el panel en donde se podrán consultar los diferentes artículos que componen la documentación de Akádemy Docs.

El Administrador de categorías presentado anteriormente está estructurado en las siguientes secciones:

• Encabezado. Es la barra superior donde se encuentra el regreso al Home, la casilla de búsqueda dentro de los artículos y la consulta de los artículos actualizados recientemente.
• Selector de categorías. Permite navegar entre las categorías, subcategorías y artículos de la documentación.
• Contenido del artículo. Sección intermedia donde se presenta el texto del artículo y las herramientas para imprimirlo y compartirlo.
• Table of contents. La tabla de contenidos es el reflejo de la estructura del artículo, que ayudan a identificar los temas y subtemas en que fue dividido el documento. Se puede navegar entre los temas dando clic sobre el nombre del tema.
• Related articles. Son enlaces que dirigen a artículos que amplían la información sobre el tema.

Encabezado del Administrador de Categorías

El encabezado es la barra superior del Administrador de Categorías de Akádemy Docs y contiene los siguientes elementos:

• Ícono para regresar a la página de inicio o el Home de la documentación.
• Selector del proyecto. Por defecto estará seleccionado el proyecto de Bitákora.
• Casilla de búsqueda. Para buscar palabras clave dentro de las categorías y artículos. Cuenta con la misma funcionalidad de la casilla de búsqueda de la página de inicio de Akádemy Docs.
• Consulta de los artículos actualizados recientemente. Contiene filtro para revisar los artículos actualizados en el último mes, la última semana y en las últimas 24 horas.

Selector de categorías

El contenido de la documentación está segmentado en categorías y subcategorías, para desglosar la información, que permitan una mejor organización, comprensión, accesibilidad y navegación.

Las categorías, subcategorías y artículos, cuentan con una estructura de carpetas de vista de árbol (tree-view), que se puede contraer o expandir para ver el contenido.

El selector de categorías de Akádemy Docs está compuesto de las siguientes secciones:

• Filtrar. Para mostrar solo las categorías que coincidan con las palabras claves escritas en la casilla de filtrar.
• Selector de categorías y subcategorías. Permite contraer y expandir las categorías y subcategorías, para luego ver el contenido el artículo.

La categoría y subcategoría se utilizan para organizar y mostrar artículos de temas similares, que funcionan como carpetas que contienen grupos de contenido relacionado.

Por ejemplo (ver imagen siguiente): el tema Eventos que afectan la liquidación es el tema principal y se creó como una categoría. Los eventos en Bitákora son un grupo bastante amplio y se clasificaron en subcategorías individuales como modificación de salario, vacaciones, incapacidades, novedades, etc. Dentro de cada subcategoría están los artículos que son los que tienen el contenido de la documentación. Esto facilita el ingreso y la navegación entre los diferentes grupos para luego consultar el artículo requerido.

En el caso del ejemplo presentado anteriormente, la categoría Eventos que afectan la liquidación, es una categoría, pero también tiene contenido, es decir que no solo funciona como carpeta principal del grupo, sino que es un artículo que se utiliza como introducción al tema. Se indica que contiene la documentación y tiene enlaces para llegar directamente a los artículos relacionados.

Table of contents

La tabla de contenidos de Akádemy Docs sirve para ayudar al lector a identificar los títulos y subtítulos en que fue dividido el artículo, de esta forma puede navegar entre el contenido dando clic sobre el título y llegando directamente el tema sin tener que recorrer o leer todo el texto del artículo.

La tabla de contenidos aparece en la parte derecha del artículo (resaltado en color rojo de la imagen anterior).

El artículo puede contener varios niveles, donde un título introduce al tema y los subtítulos se usan para distinguir el subtema, donde se presentan los argumentos o ideas que amplían el tema.

Related articles

Los articulos relacionados se muestran como enlaces al lado derecho del artículo, después de la tabla de contenidos y brindan información adicional o relacionada con el tema actual.

En la imagen de Table of contents (subcapítulo anterior) se pueden observar los artículos relacionados en color verde en la parte de abajo.

Al dar clic sobre el título del tema lo llevará directamente al capítulo seleccionado dentro del mismo artículo.

Estructura de las categorías de la documentación

Las categorías de la documentación de Bitákora están organizadas de forma similar a como se ejecuta el ciclo de la nómina. A continuación se explicará por grupo de categorías y se relacionarán con las opciones principales de la aplicación Bitákora.

Primeros pasos

Es la categoría de inicio a la documentación, la cual se recomienda que sea la primera que se consulte, para que antes de empezar a crear un empleado o liquidar la nómina, aprenda a navegar en la documentación, que luego le ayudará en la operación y en la aclaración de dudas sobre la funcionalidad de Bitákora.

El siguiente paso es conocer el Home de Bitákora y consultar las guías de inicio para contratar y liquidar un empleado en Bitákora, para que ejecute los procesos de una manera dirigida y sencilla.

Crear un contrato, registrar los eventos y liquidar la nómina de los empleados

Estos procesos abarcan varias categorías y se localizan en la sección Empleados de la página de inicio de la aplicación Bitákora.

Inician describiendo el Administrador de contratos que es donde se consulta y modifica la información del empleado, siendo de base para los procesos que siguen en Bitákora, como son la contratación y el ciclo de liquidación de la nómina.

Las categorías de la documentación que se relacionan con estos procesos, son:

• El administrador de contratos
• Contratando empleados
• Ciclo de liquidación de nómina
• Eventos que afectan la liquidación
• Modificar el contrato del empleado
• Procesos periódicos
• Reportes generales

Cierre del proceso de liquidación

Este proceso es el que trata con el pago de la nómina y se localiza en la sección Procesos de cierre de la página de inicio de la aplicación Bitákora.

Es el paso que sigue después de tener liquidada la nómina, donde se aprueban las diferentes liquidaciones, se paga la nómina en tesorería, se genera la seguridad social y se contabilizan los documentos contables.

Es una sola categoría, por esto se detallarán las subcategorías de la documentación de este proceso, que son:

• Cierre del proceso de liquidación:
  • Pagar la nómina en tesorería
  • Seguridad social
  • Contabilizar documentos
  • Contabilizar en Sinco ERP

Configuraciones de Bitákora

En esta categoría de la documentación se encuentra lo relacionado con las configuraciones del sistema y se localizan en la sección de Configuraciones de la página de inicio de la aplicación Bitákora.

Las categorías de la documentación que se relacionan con estas opciones, son:

• Configuración de conceptos de nómina
• Maestros de configuración
• Configuraciones del sistema
• Usuarios y seguridad
• Lista de normas aplicadas en Bitákora

Portal miBitákora y control de cambios

Estas dos últimas categorías se refieren a opciones que no se encuentran dentro de la página principal de Bitákora.

Las categorías de la documentación que se relacionan con estas opciones, son:

• Portal de empleados miBitákora
• Control de cambios