La definición, descripción y uso de la funcionalidaes de un producto, debe tener en cuenta unos elementos básicos de la estructura de la información que se comparte con el usuario. Los elementos a considerar son los siguientes:

División de contenidos

La documentación por producto debe evaluar la mejor forma de presentar la información al usuario y organizar los contenidos afines de la siguiente manera:

• Guia de Inicio: Es el documento de presentación del producto y donde se describen los elementos básicos y transversales para tener un primer acercamiento a la funcionalidad con items como acceso, funcionamiento o entorno de la aplicación. Ejemplo: En esta guía podrá definir con claridad los elementos básicos de la interfaz (consola web, consola móvil) y las secciones de la consola (menú principal, menú superior, área de trabajo, barra de acceso rápido entre otros.)

• Manual de Gestión: Es el documento que describe los diferentes procesos de gestión del producto y está enfocado en el usuario final. En este manual se dearrollan los procesos de gestión y configuración de la funcionalidad.

• Maual Técnico o Instalación: Es el documento más especializado que puede incluir contenidos técnicos o referencias de instalación o gestión de componentes.

Visión Conceptual

Es un primer nivel en la documentación de producto se describen los conceptos principales a desarrollar en una sección del manual, direccionando al usuario al uso secuencial de la funcionalidad

La visión conceptual del producto es una vista general de los conceptos y su interacción con otros elementos de la funcionalidad. El usuario debe tener la idea de cómo funciona el producto y su alcance de manera integral antes de conocer sus procesos internos.

⚐ Ejemplo: En a Visión Conceptual de la Configuración de ASEC se describe de forma general los conceptos que se desarrollan en esa sección como Usuarios, Licencias, servidor de correo, servicios de directorio y autenticación externa.

Orden lógico de uso

Tanto en la clasificación como en la documentación de los diferentes manuales, la información que se presenta debe reflejar el orden lógico del manejo de la funcionalidad.

El usuario debe recorrer el manual, desde la tabla de contenido al interior, de una forma secuencial que le permita realizar una gestión eficiente de lo que hace el producto, en el orden correcto.

⚐ Ejemplo: Es necesario describir en primera instancia la configuración de un a política o un usuario, antes de presentar la gestión de la política.

Descripción Procesos de Gestión

Durante la documentación de los procesos de gestión o configuración de una funcionalidad (Consultar, crear, editar, eliminar, exportar) puede utilizar diferentes recursos para optimizar el contenido (pantallas, notas tablas) y redactar la información con las siguientes pautas:

• Orden Lógico: La redacción de los contenidos debe respetar y replicar la secuencia de uso de la aplicación para describir cada uno de sus procesos

• Ubicación y Despliegue de la Interfaz: La descripción del proceso debe ser fiel a cómo funciona la aplicación y a través del lenguaje debe describir con claridad la ubicación del usuario frente a cada una de los componentes básicos de la consola.

⚐ Ejemplo: Crear Calendarios en AFLS.
1. Para crear un Calendario Personalizado, ingrese a la consola de configuración de AFLS, en la sección de Catálogo de Servicios del menú principal, seleccione la opción Calendarios. En la vista de información seleccione el botón Nuevo e ingrese la siguiente información en la Vista Detalle:

• Formular Preguntas: Generar preguntas para describir una funcionalidad y desarrollar sus conceptos en la respuesta, puede ser un mecanismo útil para direccionar los contenidos con un objetivo claro. Dependiendo el tipo de información que se quiere compartir, podrá formular diferentes interrogantes:

⚐ Nota: La formulación de preguntas es un punto de referencia para describir un proceso y no necesariamente acompañan el ejercicio descriptivo.