Documentação de Objetos

Visão Geral

Neste tópico vamos apresentar como funciona a documentação dos objetos criados no Latromi.

Objetivo

O objetivo de elaborar uma documentação específica para consultas ou formulários criados na plataforma é o de auxiliar no preenchimento e utilização desses objetos, de modo que, em caso de alguma dúvida, o usuário tenha fácil acesso a essa ajuda.

Como Fazer

Existem duas maneiras de criar a documentação. A primeira é acessando diretamente a parte de Documentos. Outro modo para acessar a parte de Documentos é via Formulário Dinâmico.

Opção 1: No Latromi Client, na aba Desenvolvimento → Documentos, fica o modo de edição da documentação.

Opção 2: Na própria aba do Formulário Dinâmico, encontra-se a opção “Gerar documentação”. Selecione os itens que deseja exportar para o documento e clique em “Gerar”. Será criado um resumo de todas as funcionalidades do formulário e tópicos predefinidos para a edição.

Lembre-se que essa documentação serve para auxiliar o usuário. Portanto deve ser explicativa, clara e objetiva. Para auxiliar nesse processo, uma série de opções de formatações de texto estão presentes na barra de ferramentas, sendo possível inserção de imagens, destaques de texto, links para outros documentos e listas.

Ao final da edição, vincule o documento ao objeto desejado. Também é possível vincular a mais de um objeto, basta adicioná-los a essa lista.

Na barra inferior do objeto, aparecerá o link para a documentação elaborada.

3 curtidas