Uso de ferramentas avançadas > Configuração de arquivos para soluções do desenvolvedor > Documentação das soluções de desenvolvedor
 

Documentação das soluções de desenvolvedor

Nota  Este tópico descreve recursos que ficam disponíveis quando a preferência geral Usar ferramentas avançadas está selecionada. Consulte Uso de ferramentas avançadas.

Você deve fornecer documentação para sua solução de banco de dados, independentemente de ser um banco de dados que deve ser aberto 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 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

Em soluções de banco de dados runtime, a licença do FileMaker Pro Advanced especifica que você deve criar um layout "Sobre" com informações de como os usuários devem entrar em contato com você para obter suporte técnico.

Para criar um layout Sobre:

1. No Modo de layout, clique em Novo layout/relatório na barra de ferramentas de status.

2. Para Nome do layout, digite Sobre <sua solução>.

Importante  Para soluções de banco de dados runtime, é preciso incluir a palavra "Sobre" no nome do layout. É preciso também incluir certas informações específicas no layout. Consulte Suas responsabilidades como desenvolvedor.

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.

7. Consulte Suas responsabilidades como desenvolvedor para obter o texto jurídico exato.

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.

11. Crie um comando de menu que mostre o layout Sobre. Consulte Definição de menus personalizados.

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 aba 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.

Consulte Criação e edição de itens de menus personalizados.

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 fazer upgrade para arquivos de nova solução (consulte Importação de dados em soluções runtime atualizadas)

como usar seu sistema de Ajuda

como iniciar a solução de banco de dados (consulte Início de soluções runtime)

o que fazer no caso de um arquivo danificado (consulte Recuperação de arquivos runtime)

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.

Recomende que os usuários façam o backup de seus dados regularmente. É possível automatizar uma parte do processo incluindo scripts que salvam cópias dos arquivos da solução. Consulte Manutenção e recuperação de bancos de dados do FileMaker Pro Advanced.

Tópicos relacionados 

Sobre a criação de soluções runtime

Preparação de arquivos para uma solução runtime

Vinculação de arquivos a uma solução runtime

Nomeação de soluções runtime