Documentação das soluções do desenvolvedor (FileMaker Pro Advanced)
Você deve fornecer documentação para sua solução de banco de dados, se for um banco de dados que deve ser aberto no FileMaker Pro, no FileMaker Pro Advanced ou em uma solução de banco de dados runtime autônoma. Há várias formas de fornecer documentação para a sua solução, incluindo um manual impresso, um sistema de Ajuda online e um
layout Sobre disponível de qualquer layout na solução.
Crie os layouts Sobre e Ajuda que documentam como é a solução de banco de dados, como usá-la e aonde os usuários podem ir para obter mais informações. Em seguida, use os menus personalizados para vincular
scripts a comandos de menu que abrem os layouts Sobre e Ajuda.
Nota O sistema de Ajuda do FileMaker Pro e do FileMaker Pro Advanced não está disponível em aplicativos runtime. Entretanto, a barra de status Ajuda (Windows) e as tags de Ajuda (macOS) estão disponíveis.
Criação de um layout Sobre
Para soluções de banco de dados runtime, a licença do FileMaker Pro Advanced especifica que você deve criar um layout Sobre que forneça informações aos seus usuários sobre como entrar em contato com você para suporte técnico.
Para criar um layout Sobre:
2. Para Nome do layout, digite Sobre <sua solução>.
3. Selecione Layout em branco.
4. Clique em Concluir.
5. Inclua no layout o seu logotipo, outros gráficos e as informações de sua empresa.
6. Inclua texto que notifique os usuários se os arquivos da solução estiverem protegidos por senha ou se os privilégios de acesso total tiverem sido removidos.
8. Crie um botão que permita que seus usuários retornem ao layout principal do arquivo principal.
9. Escolha o menu Scripts > Espaço de trabalho de script e crie um script que vai no layout Sobre.
10. Inclua a palavra Sobre no nome do script.
Para exibir o layout Sobre quando o aplicativo runtime é iniciado:
1. Abra o arquivo principal da solução de banco de dados.
2. Escolha o menu Arquivo > Opções de arquivo.
3. Na guia Abrir da caixa de diálogo Opções de arquivo, selecione Alternar para layout e escolha o layout Sobre na lista.
Criação de um layout de Ajuda personalizado
Crie um layout Ajuda que forneça instruções de como usar a solução e adicionar dados a ela. Em seguida, crie um script no arquivo principal de sua solução para exibir o sistema Ajuda. Use o recurso de menus personalizados para tornar o script disponível como comando no menu Ajuda.
Se quiser criar uma página da Web para documentar sua solução, você poderá colocar um visualizador da Web no layout Ajuda exibido na página da Web.
Inclusão de documentação impressa
Você precisará fornecer instruções aos seus usuários sobre como instalar a solução de banco de dados. A seguir, uma lista das coisas que você deve documentar:
•requisitos mínimos de equipamentos e softwares
•como instalar sua solução em pacotes
•como instalar arquivos personalizados
•como usar software que você deverá ter incluído para:
•instalar sua solução em pacotes
•descompactar os arquivos da sua solução
•como usar seu sistema de Ajuda
•como encontrá-lo para suporte técnico
Importante No caso de os arquivos da solução de banco de dados runtime terem sido danificados, certifique-se de que os usuários tenham acesso ao seu e-mail ou número de telefone de suporte técnico na documentação impressa ou em um arquivo de texto. Se um arquivo de banco de dados for danificado, eles não poderão acessar o layout Sobre da sua solução para descobrir como entrar em contato com você.
É possível também incluir as seguintes recomendações:
•Diga aos usuários para não renomear nenhum arquivo da solução (exceto o aplicativo runtime) ou eles poderão não conseguir executá-la.
Tópicos relacionados