Este documento resume los aspectos principales para documentar de modo uniforme Axional ERP.

1 Secciones de un bloque de documentación

Cada bloque de información contiene (donde es posible) siguientes secciones.

Id Título
01 Visión general
02 Principales funcionalidades
03 Modelo de datos (simple)
04 Datos relacionados (auxiliares y maestros)
05 Getting started, paso a paso
06 Acciones posibles
07 Keep in mind
08 Flujo de datos
09 Sumario
10 FAQS

Para facilitar el seguimiento, se mantiene siempre el orden y codificación de secciones. Así 05 siempre refiere al "paso a paso"

1.1 Visión general

Este bloque presenta de modo sencillo qué contiene el bloque que se despliega a continuación en la formación.
Una posible pauta de contenido es:

Item Descripción
01 Qué es objeto de documentación?
02 Qué objetivo se pretende
03 Nivel de dificultad
04 Tiempo de lectura
05 Conexiones con otros documentos

1.2 Principales funcionalidades

Este bloque presenta para que sirve y que es capaz de hacer, el bloque documentado.
Una posible pauta de contenido es:

Item Descripción
01 Utilidad principal
02 Utilidades secundarias
03 Interacción con usuario (registro, impresión, proceso)
04 Contexto de trabajo
05 Conexiones con otras utilidades

1.3 Modelo de datos (simple)

Este bloque presenta que entidades de datos guardan o facilitan la información del bloque o proceso a documentar.


No es una relación exhaustiva de tablas principales, auxiliares, datos maestros. Esto se explica en el siguiente bloque


Debe permitir comprender a primera vista, donde se almacena o demanda la información.

1.4 Auxiliares y maestros relacionados (simple)

Este bloque presenta que entidades de datos se requieren para registrar, modificar o procesar la información.


No es una relación exhaustiva de tablas principales, auxiliares, datos maestros. Existe información propia de cada repositorio


Indica los enlaces requeridos o de mayor importancia.

1.5 Getting started, paso a paso

Este bloque explica de modo simple y directo cómo se aprovecha el bloque. Por tanto cómo se selecciona, registra, modifica, procesa.
Para ello mantendrá algunas pautas comunes

Item Descripción
01 Lenguaje claro y directo
02 Tercera persona, impersonal
03 Frases cortas sin conjunciones, relativas, subordinadas
04 Vocabulario preciso
05 Párrafos cortos y espaciados suficientes
06 Evitar el uso del futuro.

1.6 Acciones posibles

Este bloque presenta que es posible realizar, llamar, procesar, desde la estructura principal que se documenta.


Si el desarrollo es extenso, entonces resulta apropiado realizar una enumeración simple. Para cada caso, documentar específicamente un bloque propio.


Cada acción debe auto explicar que consecuencias conlleva.

1.7 Keep in mind

Este bloque presenta puntos de atención, datos esenciales, etc a recordar.


Asimismo puede explicar puntos críticos en relación a origen o destino de la información


1.8 Flujo de datos

Este bloque presenta que orígenes y destinos se interconectan con la información del bloque.


Donde posible, es preferible una conceptualización gráfica


1.9 Sumario

Este bloque presenta el resumen de la información ofrecida.


Debe enfatizar los aspectos clave


1.10 FAQS

Este bloque presenta preguntas y respuestas según interacción con usuarios de la información expuesta.