Uso de las herramientas avanzadas > Configurar archivos para soluciones de desarrollador > Documentar soluciones en tiempo de ejecución
 

Documentar soluciones en tiempo de ejecución

Nota  En este tema, se describen las funciones disponibles al seleccionar la preferencia general Usar herramientas avanzadas Consulte Uso de las herramientas avanzadas.

Es necesario proporcionar documentación para la solución de base de datos, ya se trate de una base de datos que se deba abrir con FileMaker Pro Advanced o una solución de base de datos en tiempo de ejecución autónoma. Existen varias formas en que se puede proporcionar dicha información para la solución, entre las que se incluyen un manual impreso, un sistema de ayuda en línea y una presentación disponible para cualquier presentación de la solución.

Cree presentaciones personalizadas que documenten la solución de base de datos: qué es, cómo se utiliza y dónde pueden encontrar más información los usuarios. A continuación, utilice la función de menús personalizados para adjuntar guiones a comandos de menús y poder abrir las presentaciones.

Nota  El sistema de ayuda de FileMaker Pro Advanced no está disponible en aplicaciones en tiempo de ejecución. Sin embargo, está disponible la Ayuda de la barra de estado (Windows) y las etiquetas de ayuda (macOS).

Creación de presentaciones

En las soluciones de base de datos en tiempo de ejecución, la licencia de FileMaker Pro Advanced especifica que se debe crear una presentación que proporcione información para los usuarios acerca de cómo ponerse en contacto si desean asistencia técnica.

Para crear una presentación Acerca de:

1. En el modo Presentación, haga clic en la opción Nueva presentación/informe de la barra de herramientas de estado.

2. En Nombre de presentación, escriba Acerca de <la solución>.

Importante  En las soluciones de bases de datos en tiempo de ejecución, debe incluir la palabra "Acerca de" en el nombre de la presentación. También debe incluir determinada información específica en la presentación. Consulte Responsabilidades como creador.

3. Seleccione Presentación en blanco.

4. Haga clic en Finalizar.

5. Incluya en la presentación su logotipo, otros gráficos y la información de su empresa.

6. Incluya también texto que notifique a los usuarios si los archivos de la solución están protegidos con contraseñas o si se han eliminado los privilegios de acceso total.

7. Consulte Responsabilidades como creador si desea saber la redacción legal exacta.

8. Cree un botón que le permita a los usuarios volver a la presentación principal del archivo primario.

9. Seleccione el menú Guiones > Espacio de trabajo de guiones y cree un guión que acceda a Acerca de la presentación.

10. Incluya la palabra Acerca de en el nombre del guión.

11. Cree un comando del menú que muestre la presentación. Consulte Definir menús personalizados.

Para mostrar la presentación Acerca de si se inicia la aplicación en tiempo de ejecución:

1. Abra el archivo primario para la solución de base de datos.

2. Seleccione el menú Archivo > Opciones de archivo.

3. En la pestaña Abrir del cuadro de diálogo Opciones de archivo, seleccione Activar presentación y elija la presentación "Acerca de" en la lista.

Creación de una presentación de ayuda personalizada

Cree una presentación de ayuda donde se proporcione información sobre cómo utilizar la solución y agréguele datos. A continuación, cree un guión en el archivo primario de la solución para mostrarlo en el sistema de ayuda. Utilice la función Menús personalizados para que el guión esté disponible como comando en el menú Ayuda.

Si desea crear una página Web que documente su solución, puede colocar un visualizador Web en su presentación de ayuda que abra la página Web.

Consulte Creación y edición de elementos de menú personalizados.

Inclusión de documentación impresa

Deberá proporcionar instrucciones a los usuarios acerca de cómo instalar la solución de base de datos. A continuación se incluye una lista de aspectos que debería documentar:

requisitos de software y equipo mínimos

cómo instalar la solución incluida

cómo instalar archivos personalizados

cómo utilizar el software que podría haber incluido para:

instalar la solución incluida

descomprimir los archivos de la solución

cómo actualizar a archivos de solución nuevos (consulte Importar datos en las soluciones en tiempo de ejecución mejoradas)

cómo utilizar el sistema de ayuda

cómo iniciar la solución de la base de datos (consulte Iniciar soluciones en tiempo de ejecución)

qué hacer en caso de que se dañe un archivo (consulte Recuperar archivos en tiempo de ejecución)

cómo ponerse en contacto con la asistencia técnica

Importante  En caso de que los archivos de solución de base de datos en tiempo de ejecución se dañen, asegúrese de que los usuarios tengan acceso a la dirección de correo electrónico o el número de teléfono de la asistencia técnica en la documentación impresa o en un archivo de texto. Si se daña un archivo de base de datos, puede que no sea posible tener acceso a la presentación de la solución para buscar el modo de ponerse en contacto con usted.

Puede que desee incluir las siguientes recomendaciones:

Indíqueles a los usuarios que no le cambien el nombre a ningún archivo de solución (salvo la aplicación en tiempo de ejecución) o puede que no sea posible ejecutar la solución.

Recomiéndeles a los usuarios que realicen copias de seguridad de sus datos con regularidad. Puede que desee automatizar parte del proceso mediante la inclusión de guiones para guardar copias de los archivos de solución. Consulte Mantener y recuperar bases de datos de FileMaker Pro Advanced.

Temas relacionados 

Acerca de la creación de soluciones en tiempo de ejecución

Preparar archivos para una solución en tiempo de ejecución

Enlazar archivos a una solución en tiempo de ejecución

Asignar nombres a las soluciones en tiempo de ejecución